> ## Documentation Index > Fetch the complete documentation index at: https://nexus-docs.ticto.dev/llms.txt > Use this file to discover all available pages before exploring further. # Configurar cliente > Define configurações do cliente para receber notificações via webhook. **Configurações disponíveis:** - **Webhook**: URL para receber notificações de eventos - **Eventos**: Lista de eventos que o cliente deseja receber - **Status**: Ativar/desativar notificações > Para detalhes completos dos payloads de cada evento, consulte a seção **Webhooks** abaixo. **Eventos disponíveis:** - `user_updated` — Usuário atualizado - `user_onboarded` — Onboarding atualizado - `bank_account_updated` — Conta bancária atualizada - `bank_account_deleted` — Conta bancária deletada - `product_updated` — Produto atualizado - `product_deleted` — Produto deletado - `product_affiliate_deleted` — Afiliado deletado - `product_coproducer_deleted` — Coprodutor deletado - `offer_updated` — Oferta atualizada - `offer_deleted` — Oferta deletada - `refund_requested` — Reembolso solicitado - `refund_updated` — Reembolso atualizado - `cashout_requested` — Saque solicitado - `cashout_updated` — Saque atualizado - `anticipation_requested` — Antecipação solicitada - `anticipation_updated` — Antecipação atualizada - `fee_tier_updated` — Faixa de taxa criada, atualizada ou excluída - `order_created` — Pedido criado - `order_item_status_changed` — Status do item do pedido alterado - `transaction_created` — Cobrança criada - `transaction_updated` — Status da cobrança alterado - `subscription_cancelled` — Assinatura cancelada - `subscription_resumed` — Assinatura retomada - `subscription_extended` — Assinatura estendida - `subscription_overdue` — Assinatura em atraso - `subscription_ended` — Assinatura finalizada - `charge_reminder` — Lembrete de cobrança - `trial_started` — Trial iniciado - `trial_ended` — Trial finalizado ## OpenAPI ````yaml /api-reference/openapi.yaml post /client-settings openapi: 3.0.3 info: title: Nexus version: 1.0.2 description: > API para integração entre Ticto e clientes externos # Autenticação Para autenticar as solicitações aos endpoints descritos a seguir, por favor, siga os passos abaixo: 1. **Solicite** seu cadastro como cliente através do e-mail **infraestrutura@ticto.com.br** para obter seu `client_id` e `token`. 2. **Use** seu token e ID de cliente para fazer login no Nexus e obter seu `client_token`. 3. **Em todas as outras requisições**, envie seu `client_token` no header como `X-Api-Client-Token`. 4. **Crie** seus usuários na rota de criação de usuário. Para cada usuário, será retornado um `public_token` único. 5. **Para endpoints que não estão em public.php**, adicione o `public_token` do usuário no cabeçalho **Authorization** utilizando o formato: ```http Authorization: Bearer {public_token} ``` ## Restrição de origem O acesso a esta API não está disponível para todos os sellers. Seu uso é estritamente permitido para parceiros comerciais que a utilizarão em cenários específicos. Por este motivo, o acesso será restrito a endereços IP e domínios previamente informados por esses parceiros. Essa medida visa proporcionar um ambiente mais controlado e seguro para todos os nossos usuários e parceiros. ### O que isso significa para os desenvolvedores? - **Acesso Limitado:** Somente os IPs e domínios pré-autorizados poderão realizar chamadas à API. Qualquer tentativa de acesso de um IP ou domínio não listado será automaticamente rejeitada. - **Processo de Autorização:** Para garantir a continuidade do acesso à API sem interrupções, é essencial que os desenvolvedores enviem os endereços IP ou domínios que necessitam de acesso diretamente à nossa equipe de suporte. - **Como Solicitar Acesso:** Envie um e-mail para **liberacao@ticto.com.br** com o assunto _"Solicitação de Acesso à API de pagamentos"_, incluindo: - Nome da empresa ou do desenvolvedor - Endereços IP ou domínios a serem autorizados - Justificativa para o acesso - Informações de contato para eventuais esclarecimentos ## Alterações e/ou inclusão de novos domínios e IPs Recomendamos que solicitações de adição ou alteração de IPs/domínios sejam feitas o mais breve possível para garantir uma transição suave. Em casos de alterações, os domínios e/ou IPs anteriores serão imediatamente bloqueados após sua remoção. ## Suporte e Dúvidas Para dúvidas ou suporte adicional, entre em contato conosco através do e-mail **liberacao@ticto.com.br**. Estamos comprometidos em auxiliar neste processo e garantir a melhor experiência possível. servers: - url: https://nexus.ticto.com.br/api/v1 description: Produção security: [] tags: - name: Autenticação - name: Configurações do Cliente - name: Usuários - name: Onboarding de usuário - name: Contas Bancárias - name: Faixas de Taxa description: >- Endpoints para consulta de faixas de taxa personalizadas e histórico de alterações. - name: Frete - name: Financeiro - name: PIX Automático description: >- Consulta, cancelamento e nova tentativa de cobrança de assinaturas com PIX Automático (débito recorrente autorizado pelo pagador). - name: Produtos - name: Integrações - name: 'Webhooks: Usuários' description: Eventos relacionados a cadastro e atualização de usuários. - name: 'Webhooks: Contas Bancárias' description: Eventos relacionados a contas bancárias dos sellers. - name: 'Webhooks: Produtos e Ofertas' description: Eventos relacionados a produtos, ofertas, afiliados e coprodutores. - name: 'Webhooks: Financeiro' description: Eventos de reembolso, saque e antecipação. - name: 'Webhooks: Faixas de Taxa' description: Eventos de criação, atualização e exclusão de faixas de taxa. - name: 'Webhooks: Pedidos' description: Eventos de criação e atualização de pedidos. - name: 'Webhooks: Cobranças' description: >- Eventos de criação e mudança de status de cobranças (transações), na primeira compra e nas renovações. - name: 'Webhooks: Assinaturas' description: Eventos do ciclo de vida de assinaturas, cobranças e trial. paths: /client-settings: post: tags: - Configurações do Cliente summary: Configurar cliente description: > Define configurações do cliente para receber notificações via webhook. **Configurações disponíveis:** - **Webhook**: URL para receber notificações de eventos - **Eventos**: Lista de eventos que o cliente deseja receber - **Status**: Ativar/desativar notificações > Para detalhes completos dos payloads de cada evento, consulte a seção **Webhooks** abaixo. **Eventos disponíveis:** - `user_updated` — Usuário atualizado - `user_onboarded` — Onboarding atualizado - `bank_account_updated` — Conta bancária atualizada - `bank_account_deleted` — Conta bancária deletada - `product_updated` — Produto atualizado - `product_deleted` — Produto deletado - `product_affiliate_deleted` — Afiliado deletado - `product_coproducer_deleted` — Coprodutor deletado - `offer_updated` — Oferta atualizada - `offer_deleted` — Oferta deletada - `refund_requested` — Reembolso solicitado - `refund_updated` — Reembolso atualizado - `cashout_requested` — Saque solicitado - `cashout_updated` — Saque atualizado - `anticipation_requested` — Antecipação solicitada - `anticipation_updated` — Antecipação atualizada - `fee_tier_updated` — Faixa de taxa criada, atualizada ou excluída - `order_created` — Pedido criado - `order_item_status_changed` — Status do item do pedido alterado - `transaction_created` — Cobrança criada - `transaction_updated` — Status da cobrança alterado - `subscription_cancelled` — Assinatura cancelada - `subscription_resumed` — Assinatura retomada - `subscription_extended` — Assinatura estendida - `subscription_overdue` — Assinatura em atraso - `subscription_ended` — Assinatura finalizada - `charge_reminder` — Lembrete de cobrança - `trial_started` — Trial iniciado - `trial_ended` — Trial finalizado operationId: setClientSettings requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestClientSettings' responses: '201': description: Configurações salvas com sucesso content: application/json: schema: $ref: '#/components/schemas/ResponseClientSettings' '400': description: Requisição inválida - webhook_endpoint inválido ou eventos vazios '401': description: Não autorizado - token inválido '403': description: Acesso negado - cliente não tem permissão '422': description: >- Payload incorreto - campos obrigatórios ausentes ou eventos inválidos '500': description: Erro interno do servidor security: - ApiClientToken: [] components: schemas: RequestClientSettings: type: object required: - webhook_endpoint - events properties: webhook_endpoint: type: string format: url description: URL do webhook para receber notificações example: https://api.meusite.com/webhook/nexus files_domain: type: string format: url nullable: true description: >- Domínio para arquivos (e-books, etc.). Usado para validar URLs de arquivos enviados pelo cliente. example: https://files.minha-plataforma.com events: type: array items: type: string description: > Lista de eventos para receber notificações via webhook. Eventos disponíveis: `user_updated`, `user_onboarded`, `bank_account_updated`, `bank_account_deleted`, `product_updated`, `product_deleted`, `product_affiliate_deleted`, `product_coproducer_deleted`, `offer_updated`, `offer_deleted`, `refund_requested`, `refund_updated`, `cashout_requested`, `cashout_updated`, `anticipation_requested`, `anticipation_updated`, `fee_tier_updated`, `order_created`, `order_item_status_changed`, `transaction_created`, `transaction_updated`, `subscription_cancelled`, `subscription_resumed`, `subscription_extended`, `subscription_overdue`, `subscription_ended`, `charge_reminder`, `trial_started`, `trial_ended` example: - user_updated - user_onboarded - bank_account_updated - bank_account_deleted - product_updated - product_deleted - product_affiliate_deleted - product_coproducer_deleted - offer_updated - offer_deleted - refund_requested - refund_updated - cashout_requested - cashout_updated - anticipation_requested - anticipation_updated - fee_tier_updated - order_created - order_item_status_changed - transaction_created - transaction_updated - subscription_cancelled - subscription_resumed - subscription_extended - subscription_overdue - subscription_ended - charge_reminder - trial_started - trial_ended active: type: boolean nullable: true description: Status ativo/inativo das notificações example: true logo: type: string format: url nullable: true description: URL do logotipo do cliente example: https://cdn.minha-plataforma.com/logo.png ResponseClientSettings: type: object required: - webhook_endpoint - events properties: webhook_endpoint: type: string format: url description: URL do webhook configurada example: https://api.meusite.com/webhook/nexus files_domain: type: string format: url nullable: true description: Domínio para arquivos configurado example: https://files.minha-plataforma.com events: type: array items: type: string description: Lista de eventos configurados example: - user_updated - user_onboarded - bank_account_updated - bank_account_deleted - product_updated - product_deleted - product_affiliate_deleted - product_coproducer_deleted - offer_updated - offer_deleted - refund_requested - refund_updated - cashout_requested - cashout_updated - anticipation_requested - anticipation_updated - fee_tier_updated - order_created - order_item_status_changed - transaction_created - transaction_updated - subscription_cancelled - subscription_resumed - subscription_extended - subscription_overdue - subscription_ended - charge_reminder - trial_started - trial_ended active: type: boolean nullable: true description: Status ativo/inativo das notificações logo: type: string format: url nullable: true description: URL do logotipo do cliente example: https://cdn.minha-plataforma.com/logo.png securitySchemes: ApiClientToken: type: apiKey in: header name: X-Api-Client-Token description: Token de autenticação do cliente obtido via endpoint /auth ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.