### GET api/produtos Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Endpoint para consultar todos os produtos cadastrados. ```APIDOC ## GET api/produtos ### Description Retorna a lista de todos os produtos cadastrados através da plataforma da TMB. ### Method GET ### Endpoint https://api.tmbeducacao.com.br/api/produtos ### Parameters Nenhum parâmetro documentado. ### Request Example ``` GET api/produtos HTTPS/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ### Response #### Success Response (200) - **produto_id** (integer) - Identificador único do produto. - **produto_nome** (string) - Nome do produto. - **descricao** (string) - Descrição do produto. - **valor_total** (string) - Ticket médio do produto. - **ativo** (boolean) - Indica se o produto está ativo (true ou false). #### Response Example ``` [ { "produto_id": 1, "produto_nome": "Produto 1", "descricao": "Descrição 1", "valor_total": "R$ 1.000,00", "ativo": true }, { "produto_id": 2, "produto_nome": "Produto 2", "descricao": "Descrição 2", "valor_total": "R$ 2.000,00", "ativo": false } ] ``` ``` -------------------------------- ### GET api/oferta?produto_id={id} Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Retorna a lista de todas as ofertas cadastradas para um produto específico. Requer autenticação via token de acesso. ```APIDOC ## GET api/oferta?produto_id={id} ### Description Retorna a lista de todas as ofertas cadastradas. ### Method GET ### Endpoint api/oferta?produto_id={id} ### Parameters #### Query Parameters - **produto_id** (integer) - Obrigatório - Identificador do produto para filtrar as ofertas. ### Request Example ```http GET api/oferta?produto_id=123 HTTP/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ### Response #### Success Response (200) - **titulo** (string) - Título da oferta. - **url** (string) - Link da oferta. #### Response Example ```json [ { "titulo": "Sua Oferta 1", "url": "https://pay.tmbeducacao.com.br/infoprodutor/xxx12" }, { "titulo": "Sua Oferta 2", "url": "https://pay.tmbeducacao.com.br/infoprodutor/xxx13" } ] ``` ``` -------------------------------- ### GET api/oferta?produto_id={id} - Exemplo de Requisição Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Requisição HTTP para listar ofertas de um produto específico, identificado pelo parâmetro produto_id. ```http GET api/oferta?produto_id=123 HTTP/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` -------------------------------- ### GET api/oferta?produto_id={id} - Exemplo de Retorno Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Resposta da API com a lista de ofertas cadastradas para o produto, contendo título e URL de cada oferta. ```json [ { "titulo": "Sua Oferta 1", "url": "https://pay.tmbeducacao.com.br/infoprodutor/xxx12" }, { "titulo": "Sua Oferta 2", "url": "https://pay.tmbeducacao.com.br/infoprodutor/xxx13" } ] ``` -------------------------------- ### Consultar Produtos Cadastrados - GET api/produtos Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Exemplo de requisição para listar todos os produtos cadastrados na plataforma TMB. O cURL equivalente é fornecido. ```http GET api/produtos HTTPS/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ```bash curl -X GET https://api.tmbeducacao.com.br/api/produtos \ -H "Authorization: Bearer {seu_token} ``` -------------------------------- ### GET api/pedidos/DetalhePedidoEfetivado Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Endpoint para obter detalhes completos de um pedido efetivado. ```APIDOC ## GET api/pedidos/DetalhePedidoEfetivado ### Description Retorna detalhes completos de um pedido previamente efetivado. ### Method GET ### Endpoint https://api.tmbeducacao.com.br/api/pedidos/DetalhePedidoEfetivado ### Parameters #### Query Parameters - **pedido_id** (integer) - Obrigatório - Identificador do pedido. Exemplo: 123 ### Request Example ``` GET api/pedidos/DetalhePedidoEfetivado?pedido_id=123 HTTPS/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ### Response #### Success Response (200) Retorna os detalhes completos do pedido efetivado. (Estrutura não detalhada na documentação.) ``` -------------------------------- ### GET api/pedidos Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Endpoint para consultar pedidos efetivados com filtros opcionais. ```APIDOC ## GET api/pedidos ### Description Retorna a lista paginada de pedidos realizados para um determinado produto, podendo ser filtrada por intervalo de datas. ### Method GET ### Endpoint https://api.tmbeducacao.com.br/api/pedidos ### Parameters #### Query Parameters - **produto_id** (integer) - Opcional - O ID do Produto. Exemplo: 123 - **data_inicio** (datetime) - Opcional - Data inicial do filtro. Exemplo: 2025-05-31 - **data_final** (datetime) - Opcional - Data final do filtro. Exemplo: 2025-05-31 - **pageNumber** (integer) - Opcional - Número da página (default = 1). Exemplo: 1 - **pageSize** (integer) - Opcional - Tamanho da página (default = 7). Exemplo: 7 ### Request Example ``` GET api/pedidos?produto_id=123&pageNumber=1&pageSize=7&data_inicio=2026-03-01&data_final=2026-03-06 HTTPS/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ### Response #### Success Response (200) - **produtor** (string) - Nome do produtor. - **lancamento** (string) - Nome do lançamento. - **pedido_id** (integer) - Identificador do pedido. - **status_pedido** (string) - Status do pedido. - **cliente** (string) - Nome do cliente. - **documento** (string) - Documento do cliente. - **email** (string) - Email do cliente. - **valor_total** (number) - Valor total do pedido. - **parcelas** (integer) - Número de parcelas. - **valor_entrada** (number) - Valor de entrada. - **valor_parcela** (number) - Valor de cada parcela. - **taxa_administracao** (number) - Taxa de administração. - **criado_em** (string) - Data de criação do pedido. - **data_efetivado** (string) - Data de efetivação do pedido. - **endereco_completo** (string) - Endereço completo. - **telefone** (string) - Telefone do cliente. - **produto_id** (integer) - ID do produto. - **nascimento** (string) - Data de nascimento do cliente. - **produtor_id** (integer) - ID do produtor. - **status_financeiro** (string) - Status financeiro. - **utm_source** (string) - UTM source (pode ser null). - **utm_medium** (string) - UTM medium (pode ser null). - **utm_content** (string) - UTM content (pode ser null). - **utm_campaign** (string) - UTM campaign (pode ser null). - **melhor_dia_pagamento** (integer) - Melhor dia para pagamento. - **utm_last_source** (string) - Última UTM source (pode ser null). - **utm_last_medium** (string) - Última UTM medium (pode ser null). - **utm_last_content** (string) - Última UTM content (pode ser null). - **utm_last_campaign** (string) - Última UTM campaign (pode ser null). - **pais** (string) - País. - **cep** (string) - CEP. - **endereco_estado** (string) - Estado. - **endereco_cidade** (string) - Cidade. - **endereco_bairro** (string) - Bairro. - **endereco_logradouro** (string) - Logradouro. - **endereco_numero** (string) - Número do endereço. - **endereco_complemento** (string) - Complemento (pode ser null). #### Response Example ``` { "produtor": "Produtor 1", "lancamento": "Produto Dois", "pedido_id": 1234, "status_pedido": "Efetivado", "cliente": "Fulano de Tal", "documento": "1234567890", "email": "fulano@tmbeducacao.com", "valor_total": 5000, "parcelas": 3, "valor_entrada": 1250.0000, "valor_parcela": 1250.0000, "taxa_administracao": 5.00, "criado_em": "2025-04-23T14:32:19.601455-03:00", "data_efetivado": "2025-04-23T14:32:46.752423", "endereco_completo": "Rua Platina, 1021 - São Paulo/SP CEP:03308-010 BR", "telefone": "+5511999999999", "produto_id": 123, "nascimento": "1994-01-01T00:00:00", "produtor_id": 1, "status_financeiro": "Adimplente", "utm_source": null, "utm_medium": null, "utm_content": null, "utm_campaign": null, "melhor_dia_pagamento": 20, "utm_last_source": null, "utm_last_medium": null, "utm_last_content": null, "utm_last_campaign": null, "pais": "BR", "cep": "03308-010", "endereco_estado": "SP", "endereco_cidade": "São Paulo", "endereco_bairro": "Vila Azevedo", "endereco_logradouro": "Rua Platina", "endereco_numero": "12345", "endereco_complemento": null } ``` ``` -------------------------------- ### Detalhe de Pedidos Efetivados - GET api/pedidos/DetalhePedidoEfetivado Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Exemplo de requisição para obter detalhes completos de um pedido efetivado, informando o pedido_id. O cURL equivalente é fornecido. ```http GET api/pedidos/DetalhePedidoEfetivado?pedido_id=123 HTTPS/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ```bash curl -X GET https://api.tmbeducacao.com.br/api/DetalhePedidoEfetivado?pedido_id=123 \ -H "Authorization: Bearer {seu_token} ``` -------------------------------- ### Consultar Pedidos Efetivados - GET api/pedidos Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Exemplo de requisição para consultar pedidos efetivados com filtros opcionais (produto_id, data_inicio, data_final, pageNumber, pageSize). O cURL equivalente é fornecido. ```http GET api/pedidos?produto_id=123&pageNumber=1&pageSize=7&data_inicio=2026-03-01&data_final=2026-03-06 HTTPS/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} ``` ```bash curl -X GET https://api.tmbeducacao.com.br/api/pedidos?produto_id=123&pageNumber=1&pageSize=7&data_inicio=2026-03-01&data_final=2026-03-06 \ -H "Authorization: Bearer {seu_token} ``` -------------------------------- ### Exemplo de JSON para o endpoint Notazz [POST] Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/notazz Modelo do payload JSON enviado via POST para o endpoint Notazz, seguido de um exemplo preenchido com valores fictícios. O campo METHOD deve ser definido como "create_nfse" para gerar a nota fiscal de serviço. ```json { "METHOD": string, "DESTINATION_NAME": string, "DESTINATION_TAXID": string, "DESTINATION_TAXTYPE": string, "DESTINATION_STREET": string, "DESTINATION_NUMBER": string, "DESTINATION_COMPLEMENT": null, "DESTINATION_DISTRICT": string, "DESTINATION_CITY": string, "DESTINATION_UF": string, "DESTINATION_ZIPCODE": string, "DESTINATION_PHONE": string, "DESTINATION_EMAIL": string, "DOCUMENT_BASEVALUE": int, "DOCUMENT_DESCRIPTION": string } ``` ```json { "METHOD": "create_nfse", "DESTINATION_NAME": "Nome do Cliente", "DESTINATION_TAXID": "069.242.814-00", "DESTINATION_TAXTYPE": "F", "DESTINATION_STREET": "Rua Coronel Madeira", "DESTINATION_NUMBER": "23", "DESTINATION_COMPLEMENT": null, "DESTINATION_DISTRICT": "Centro", "DESTINATION_CITY": "São Paulo", "DESTINATION_UF": "SP", "DESTINATION_ZIPCODE": "12223330", "DESTINATION_PHONE": "+1199999999", "DESTINATION_EMAIL": "teste@gmail.com", "DOCUMENT_BASEVALUE": 2000, "DOCUMENT_DESCRIPTION": "Nome do Lançamento" } ``` -------------------------------- ### Exemplo de JSON do Webhook Financeiro (POST) Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/financeiro Exemplo de JSON enviado via POST para o endpoint do webhook financeiro. O primeiro bloco mostra a estrutura com tipos de dados, e o segundo apresenta um exemplo real com valores preenchidos. O campo status_pagamento pode assumir valores como 'Aguardando Pagamento', 'Recebido', 'Vencido', 'DELETED' ou 'Estornado'. ```json [ { "dados": { "pedido_id": int, "cliente_documento": string, "id_externo": string, "produto":string, "parcela": int, "vencimento_parcela": datetime, "data_pagamento": datetime, "status_pagamento": string, "parcela_id": string, "repasse": double, "modalidade_contrato": string, "cliente": string, "cliente_email": string, "lancamento_id": int, "valor_parcela_sem_juros": double } } ] ``` ```json [ { "dados": { "pedido_id":60920, "cliente_documento":"931.275.121-20", "id_externo":"1", "produto":"Monitor Ultrawide", "parcela":2, "vencimento_parcela":"2023-08-10T00:00:00", "data_pagamento":null, "status_pagamento":"Aguardando Pagamento", "parcela_id":"e4d003d9-9b37-40b9-85fd-5ad7569cf0ac", "repasse":2423.10000000000000000000, "modalidade_contrato":"Descomplicado", "cliente": "Nome de Teste", "cliente_email": "teste@gmail.com", "lancamento_id": 2027, "valor_parcela_sem_juros": 237.49 } } ] ``` -------------------------------- ### Exemplo de JSON para o endpoint Spedy [POST] Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/spedy Exemplo do payload JSON enviado via POST para o endpoint Spedy quando o evento de pedido Efetivado é acionado. O primeiro bloco mostra a estrutura com tipos e comentários; o segundo é um exemplo concreto com valores preenchidos. ```json { "transactionId": int, //ID do pedido "customer": { "name": string, //Nome do cliente "federalTaxNumber": string, //Documento do cliente "email": string, //E-mail do cliente //Dados de endereço do cliente: "address": { "street": string, "district": string, "postalCode": string, "number": string, "additionalInformation": null, "city": { "name": string, "state": string } } }, "amount": double, //valor do ticket "date": string, //data de efetivação "status": string, //fixo "paymentMethod": string, //fixo "autoIssueMode": string, //fixo "profileType": string, //fixo "items": [ { "quantity": int, //fixo "price": double, //valor do ticket "amount": double, //valor do ticket "product": { "name": string, //nome do produto "code": int, //id do produto "price": double //valor do ticket } } ] } ``` ```json { "transactionId": 63178, "customer": { "name": "Nome do cliente", "federalTaxNumber": "78409885395", "email": "teste@gmail.com", "address": { "street": "Rua X", "district": "Vila Velha", "postalCode": "12345-010", "number": "1010", "additionalInformation": null, "city": { "name": "São Paulo", "state": "SP" } } }, "amount": 5000.0, "date": "2024-06-17T11:17:30.441091", "status": "approved", "paymentMethod": "billetBank", "autoIssueMode": "disabled", "profileType": "producer", "items": [ { "quantity": 1, "price": 5000.0, "amount": 5000.0, "product": { "name": "Nome do produto", "code": 979, "price": 5000.0 } } ] } ``` -------------------------------- ### Resposta de Consultar Produtos Cadastrados Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Exemplo de retorno da consulta de produtos, contendo uma lista com produto_id, produto_nome, descricao, valor_total e ativo. ```json [ { "produto_id": 1, "produto_nome": "Produto 1", "descricao": "Descrição 1", "valor_total": "R$ 1.000,00", "ativo": true }, { "produto_id": 2, "produto_nome": "Produto 2", "descricao": "Descrição 2", "valor_total": "R$ 2.000,00", "ativo": false } ] ``` -------------------------------- ### Resposta de Consultar Pedidos Efetivados Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Exemplo de retorno da consulta de pedidos efetivados, contendo dados do pedido, cliente, valores, endereço e informações de UTM. ```json { "produtor": "Produtor 1", "lancamento": "Produto Dois", "pedido_id": 1234, "status_pedido": "Efetivado", "cliente": "Fulano de Tal", "documento": "1234567890", "email": "fulano@tmbeducacao.com", "valor_total": 5000, "parcelas": 3, "valor_entrada": 1250.0000, "valor_parcela": 1250.0000, "taxa_administracao": 5.00, "criado_em": "2025-04-23T14:32:19.601455-03:00", "data_efetivado": "2025-04-23T14:32:46.752423", "endereco_completo": "Rua Platina, 1021 - São Paulo/SP CEP:03308-010 BR", "telefone": "+5511999999999", "produto_id": 123, "nascimento": "1994-01-01T00:00:00", "produtor_id": 1, "status_financeiro": "Adimplente", "utm_source": null, "utm_medium": null, "utm_content": null, "utm_campaign": null, "melhor_dia_pagamento": 20, "utm_last_source": null, "utm_last_medium": null, "utm_last_content": null, "utm_last_campaign": null, "pais": "BR", "cep": "03308-010", "endereco_estado": "SP", "endereco_cidade": "São Paulo", "endereco_bairro": "Vila Azevedo", "endereco_logradouro": "Rua Platina", "endereco_numero": "12345", "endereco_complemento": null } ``` -------------------------------- ### Exemplo de JSON de notificação Active Campaign Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/active-campaign Exemplo de JSON recebido na plataforma via POST. O primeiro bloco mostra a estrutura com tipos de dados, e o segundo um exemplo com valores reais. Inclui campos como contato_id, tags_inclusao, listas_inclusao e tags_exclusao. ```json { "contato_id": string, "contato_primeiro_nome": string, "contato_ultimo_nome": string, "contato_email": string, "contato_telefone": string, "tags_inclusao": [ { "id": string, "nome": string }, { "id": string, "nome": string } ], "listas_inclusao": [ { "id": string, "nome": string } ], "tags_exclusao": [] } ``` ```json { "contato_id": "78", "contato_primeiro_nome": "Nome", "contato_ultimo_nome": "Cliente", "contato_email": "teste@gmail.com", "contato_telefone": "+551199999999", "tags_inclusao": [ { "id": "1", "nome": "Minha tag inicial" }, { "id": "10", "nome": "[TMB] - Seleção de Parcelas" } ], "listas_inclusao": [ { "id": "1", "nome": "Master Contact List" } ], "tags_exclusao": [] } ``` -------------------------------- ### POST api/ofertas - Exemplo de Requisição Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Requisição HTTP para cadastrar uma nova oferta. Inclui cabeçalhos de autenticação e corpo JSON com os parâmetros obrigatórios. ```http POST api/ofertas HTTP/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} Content-Type: application/json { "titulo": "string", "produto_id": 0, "valor_principal": 0, "valor_boleto_entrada": 0, "vencimento_boleto_entrada": "2025-01-30", "qtd_parcelas": "string" } ``` -------------------------------- ### POST api/ofertas - Exemplo de Retorno Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Resposta da API ao cadastrar uma oferta, contendo status e URL da oferta criada. ```json { "status": "Oferta criada com sucesso", "url": "https://pay.tmbeducacao.com.br/tmb/ZBP57850W4" } ``` -------------------------------- ### POST api/ofertas Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Cadastra uma nova oferta para um produto. Requer autenticação via token de acesso. ```APIDOC ## POST api/ofertas ### Description Cadastra uma nova oferta para um produto. ### Method POST ### Endpoint api/ofertas ### Parameters #### Request Body - **titulo** (string) - Obrigatório - O título da oferta. - **produto_id** (integer) - Obrigatório - Identificador único do produto. - **valor_principal** (float) - Obrigatório - Valor do Ticket. - **valor_boleto_entrada** (float) - Opcional - Valor customizado do boleto de entrada. - **vencimento_boleto_entrada** (string) - Opcional - Data customizada do vencimento do boleto de entrada (formato YYYY-MM-DD). Regra: A data personalizada do boleto deve ser pelo menos 3 dias após a data atual e no máximo 60 dias a partir da data atual. - **qtd_parcelas** (string) - Obrigatório - Quantidade de parcelas disponível no financiamento (sujeito a validação de ticket e quantidade de parcelas). ### Request Example ```json POST api/ofertas HTTP/1.1 Host: api.tmbeducacao.com.br Authorization: Bearer {seu_token} Content-Type: application/json { "titulo": "string", "produto_id": 0, "valor_principal": 0, "valor_boleto_entrada": 0, "vencimento_boleto_entrada": "2025-01-30", "qtd_parcelas": "string" } ``` ### Response #### Success Response (200) - **status** (string) - Mensagem de sucesso. - **url** (string) - Link da oferta recém-criada. #### Response Example ```json { "status": "Oferta criada com sucesso", "url": "https://pay.tmbeducacao.com.br/tmb/ZBP57850W4" } ``` ``` -------------------------------- ### POST api/ofertas - cURL Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Comando cURL para cadastrar uma oferta com valores de exemplo. Utiliza o endpoint https://api.tmbeducacao.com.br/api/ofertas. ```bash curl -X POST https://api.tmbeducacao.com.br/api/ofertas \ -H "Authorization: Bearer {seu_token}" \ -H "Content-Type: application/json" \ -d '{ "titulo": "Promoção Inverno", "produto_id": 123, "valor_principal": 299.99, "valor_boleto_entrada": 50.00, "vencimento_boleto_entrada": "2025-01-30", "qtd_parcelas": "12" }' ``` -------------------------------- ### Exemplo de JSON de notificação POST Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/vendas Modelo de notificação POST enviado ao endpoint, com a estrutura de campos e um exemplo preenchido. O payload inclui dados do pedido, cliente, valores, UTM e endereço; campos opcionais podem vir como null. ```json { "produtor": string, "lancamento": string, "provedor_negociado": string, "pedido": int, "status_pedido": string, "cliente": string, "documento": string, "email": string, "score": null, "probabilidade_inadimplencia": null, "endereco_complemento": string, "valor_principal": double, "parcelas": int, "valor_entrada": double, "valor_parcela": double, "valor_total": double, "taxa_administracao": double, "criado_em": datetime, "data_efetivado": datetime, "vendedor": null, "titulo": string, "code": string, "endereco_completo": string, "telefones": string, "telefone_ativo": string, "lancamento_id": int, "id_externo": string, "risco_compartilhado_em": datetime, "avalista_nome": null, "avalista_telefone": null, "avalista_email": null, "avalista_documento": null, "avalista_score": null, "probabilidade_inadimplencia_avalista": null, "avalista_data_nascimento": null, "nascimento": datetime, "id": int, "contrato": null, "produtor_id": int, "observacoes": null, "status_financeiro": string, "status_cobranca": null, "status_juridico": null, "valor_entrada_sem_juros": double, "valor_parcela_sem_juros": double, "utm_source": string, "utm_medium": string, "utm_content": string, "utm_campaign": string, "melhor_dia_pagamento": int, "utm_last_source": string, "utm_last_medium": string, "utm_last_content": string, "utm_last_campaign": string, "endereco_pais": string, "endereco_cep": string, "endereco_estado": string, "endereco_cidade": string, "endereco_bairro": string, "endereco_logradouro": string, "endereco_numero": string, "endereco_complemento": string } ``` ```json { "produtor": "Nome do Produtor", "lancamento": "Nome do Lançamento", "provedor_negociado": "TMB", "pedido": 166051, "status_pedido": "Efetivado", "cliente": "Nome do Cliente", "documento": "069.242.814-00", "email": "teste@gmail.com", "score": null, "probabilidade_inadimplencia": null, "endereco_complemento": "D1 103", "valor_principal": 397.00, "parcelas": 11, "valor_entrada": 143.0000, "valor_parcela": 143.0000, "valor_total": 1997.00, "taxa_administracao": 3.00, "criado_em": "2022-11-17T00:00:00", "data_efetivado": "2022-11-17T00:00:00", "vendedor": null, "titulo": "RC - R$ 1.997,00", "code": "TS1234", "endereco_completo": "Rua X, 942 D1 103 - CEP:1234-200 BR", "telefones": "+1199999999", "telefone_ativo": "+1199999999", "lancamento_id": 200, "id_externo": "", "risco_compartilhado_em": "2022-11-17T00:00:00", "avalista_nome": null, "avalista_telefone": null, "avalista_email": null, "avalista_documento": null, "avalista_score": null, "probabilidade_inadimplencia_avalista": null, "avalista_data_nascimento": null, "nascimento": "1990-11-23T00:00:00", "id": 300123, "contrato": null, "produtor_id": 150, "observacoes": null, "status_financeiro": "Quitado", "status_cobranca": null, "status_juridico": null, "valor_entrada_sem_juros": 143.0000, "valor_parcela_sem_juros": 143.0000, "utm_source": "teste_trafego", "utm_medium": "teste_facebook", "utm_content": "teste_vendedor", "utm_campaign": "teste_campanha", "melhor_dia_pagamento": 20, "utm_last_source": "teste_campanha", "utm_last_medium": "teste_vendedor", "utm_last_content": "teste_facebook", "utm_last_campaign": "teste_trafego", "endereco_pais": "BR", "endereco_cep": "1234-200", "endereco_estado": "SP", "endereco_cidade": "São Paulo", "endereco_bairro": "Vila Velha", "endereco_logradouro": "Rua X", "endereco_numero": "942", "endereco_complemento": "D1 103" } ``` -------------------------------- ### Base URL da API Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api URL base para todas as requisições à API REST da TMB. ```text https://api.tmbeducacao.com.br ``` -------------------------------- ### POST /endpoint Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/spedy Receives a POST notification with a JSON payload when a purchase event occurs. The payload contains transaction details, customer information, and item data. ```APIDOC ## [POST] /endpoint ### Description Receives a POST notification with a JSON payload when a purchase event occurs. The payload contains transaction details, customer information, and item data. ### Method POST ### Endpoint /endpoint ### Parameters #### Request Body - **transactionId** (int) - Required - ID do pedido - **customer** (object) - Required - Dados do cliente - **name** (string) - Required - Nome do cliente - **federalTaxNumber** (string) - Required - Documento do cliente - **email** (string) - Required - E-mail do cliente - **address** (object) - Required - Dados de endereço do cliente - **street** (string) - Required - Rua - **district** (string) - Required - Bairro - **postalCode** (string) - Required - CEP - **number** (string) - Required - Número - **additionalInformation** (null) - Optional - Informações adicionais - **city** (object) - Required - Cidade - **name** (string) - Required - Nome da cidade - **state** (string) - Required - Estado - **amount** (double) - Required - Valor do ticket - **date** (string) - Required - Data de efetivação - **status** (string) - Required - Fixo - **paymentMethod** (string) - Required - Fixo - **autoIssueMode** (string) - Required - Fixo - **profileType** (string) - Required - Fixo - **items** (array) - Required - Lista de itens - **quantity** (int) - Required - Fixo - **price** (double) - Required - Valor do ticket - **amount** (double) - Required - Valor do ticket - **product** (object) - Required - Dados do produto - **name** (string) - Required - Nome do produto - **code** (int) - Required - ID do produto - **price** (double) - Required - Valor do ticket ### Request Example { "transactionId": 63178, "customer": { "name": "Nome do cliente", "federalTaxNumber": "78409885395", "email": "teste@gmail.com", "address": { "street": "Rua X", "district": "Vila Velha", "postalCode": "12345-010", "number": "1010", "additionalInformation": null, "city": { "name": "São Paulo", "state": "SP" } } }, "amount": 5000.0, "date": "2024-06-17T11:17:30.441091", "status": "approved", "paymentMethod": "billetBank", "autoIssueMode": "disabled", "profileType": "producer", "items": [ { "quantity": 1, "price": 5000.0, "amount": 5000.0, "product": { "name": "Nome do produto", "code": 979, "price": 5000.0 } } ] } ### Response #### Success Response (200) No response body is specified in the source. #### Response Example No response example is provided in the source. ``` -------------------------------- ### Autenticação Bearer Token Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/tmb-api Header de autenticação obrigatório para todos os endpoints da API. Substitua {seu_token} pelo token fornecido após o cadastro do produto e assinatura do contrato. ```http Authorization: Bearer {seu_token} ``` -------------------------------- ### POST Notazz Webhook Endpoint Source: https://info.tmbeducacao.com.br/portal-do-produtor/central-de-ajuda/produto/integracoes/notazz This endpoint receives POST notifications with JSON payloads when purchase events occur, enabling integration with Notazz for fiscal note generation. ```APIDOC ## [POST] Notazz Webhook Endpoint ### Description Receives a POST notification with a JSON payload when a purchase event is triggered (Efetivado). The payload contains destination and document information to generate the fiscal note in Notazz. ### Method POST ### Endpoint Notazz Webhook Endpoint ### Parameters #### Request Body - **METHOD** (string) - Required - The method to be executed, e.g., "create_nfse". - **DESTINATION_NAME** (string) - Required - Customer name. - **DESTINATION_TAXID** (string) - Required - Customer tax ID (CPF/CNPJ). - **DESTINATION_TAXTYPE** (string) - Required - Tax type: "F" for physical person, "J" for legal entity. - **DESTINATION_STREET** (string) - Required - Street address. - **DESTINATION_NUMBER** (string) - Required - Address number. - **DESTINATION_COMPLEMENT** (string or null) - Optional - Address complement. - **DESTINATION_DISTRICT** (string) - Required - District/neighborhood. - **DESTINATION_CITY** (string) - Required - City. - **DESTINATION_UF** (string) - Required - State abbreviation (UF). - **DESTINATION_ZIPCODE** (string) - Required - Postal code. - **DESTINATION_PHONE** (string) - Required - Phone number. - **DESTINATION_EMAIL** (string) - Required - Email address. - **DOCUMENT_BASEVALUE** (int) - Required - Base value of the document. - **DOCUMENT_DESCRIPTION** (string) - Required - Description of the document. ### Request Example ```json { "METHOD": "create_nfse", "DESTINATION_NAME": "Nome do Cliente", "DESTINATION_TAXID": "069.242.814-00", "DESTINATION_TAXTYPE": "F", "DESTINATION_STREET": "Rua Coronel Madeira", "DESTINATION_NUMBER": "23", "DESTINATION_COMPLEMENT": null, "DESTINATION_DISTRICT": "Centro", "DESTINATION_CITY": "São Paulo", "DESTINATION_UF": "SP", "DESTINATION_ZIPCODE": "12223330", "DESTINATION_PHONE": "+1199999999", "DESTINATION_EMAIL": "teste@gmail.com", "DOCUMENT_BASEVALUE": 2000, "DOCUMENT_DESCRIPTION": "Nome do Lançamento" } ``` ### Response #### Success Response (200) No response schema is explicitly documented. The endpoint is expected to acknowledge receipt of the notification. #### Response Example No response example is provided in the source. ### Error Handling No error handling details are provided in the source. It is recommended to monitor the event log for delivery status (success, error, scheduled) and to handle new attributes gracefully to avoid exceptions. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.