docs.global.sistematodos.com.br Open in urlscan Pro
54.167.3.85  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (12)




Public


Documentation Settings

ENVIRONMENT
Docs publish

LAYOUT
Double Column

LANGUAGE
cURL - cURL



CTN-GLOBAL
Introduction
Person
Files
Services
Financeiro
Contracts


CTN-GLOBAL

Bem-vindo à documentação técnica da API desenvolvida em Node.js, utilizando AWS
Lambdas e Step Functions! Esta documentação foi elaborada para fornecer uma
visão abrangente e detalhada sobre como utilizar e interagir com nossa API,
permitindo uma integração suave e eficiente em seu sistema.


SOBRE A API

Nossa API é construída sobre a infraestrutura serverless da AWS, aproveitando os
serviços de AWS Lambdas e Step Functions para garantir alta disponibilidade,
escalabilidade automática e baixa latência em todas as operações. Com uma
arquitetura orientada a eventos e state machines, nossa API oferece uma
abordagem moderna e eficaz para atender às necessidades de comunicação e
processamento de dados em tempo real.


RECURSOS PRINCIPAIS

   
 * Endpoints RESTful: A API fornece uma série de endpoints RESTful que permitem
   que você interaja com diferentes recursos e execute diversas operações.
   
 * Integração com Step Functions: Utilizando Step Functions, nossa API oferece
   fluxos de trabalho stateful e orquestração de tarefas complexas de forma
   fácil e flexível.
   
 * Segurança: Implementamos medidas robustas de segurança, incluindo
   autenticação e autorização baseadas em tokens JWT, para proteger seus dados e
   garantir que apenas usuários autorizados possam acessar os recursos.
   
 * Documentação Aberta: Estamos comprometidos em fornecer uma documentação
   detalhada e atualizada, visando facilitar a integração e o desenvolvimento de
   aplicativos.
   


COMO UTILIZAR ESTA DOCUMENTAÇÃO

   
 * Referência de Endpoints: Aqui você encontrará uma lista completa de todos os
   endpoints disponíveis, juntamente com os métodos HTTP suportados e os
   parâmetros necessários.
   
 * Exemplos de Uso: Apresentamos exemplos práticos de como realizar diferentes
   operações usando nossa API, ajudando você a entender melhor como integrá-la
   em seu sistema.
   
 * Guia de Autenticação: Para garantir uma integração segura, fornecemos
   instruções detalhadas sobre como autenticar suas solicitações e obter acesso
   aos recursos protegidos.
   
 * Melhores Práticas: Oferecemos orientações sobre as melhores práticas para
   otimizar o desempenho, a segurança e a confiabilidade de suas integrações com
   nossa API.
   

Estamos comprometidos em fornecer uma experiência de integração suave e
eficiente. Se você tiver alguma dúvida, feedback ou problema técnico, não hesite
em entrar em contato com nossa equipe de suporte dedicada.

Obrigado por escolher nossa API. Estamos ansiosos para ver como ela pode ajudar
a impulsionar o sucesso de seu sistema!

Atenciosamente,
Equipe Backend - CTN Global
Desenvolvimento - TODOS Empreendimentos

AUTHORIZATIONBearer Token
Token

string


PERSON

AUTHORIZATIONBearer Token
This folder is using Bearer Token from collectionCTN-GLOBAL

PERSON

AUTHORIZATIONBearer Token
This folder is using Bearer Token from collectionCTN-GLOBAL



POSTCREATE PERSONS BY AFFILIATION FLOW.


https://api.global.sistematodos.com.br/homolog/affiliates
AUTHORIZATIONBearer Token
Token

string

Bodyraw (json)
View More
json


{
    "createPersons": {
        "holder": {
            "name": "Maria Marilidia",
            "email": "maria@marilidia.com",
            "documents": [
                {
                    "documentType": "cpf",
                    "documentInformation": "70512465002"
                }
            ],
            "maritalStatus": "SINGLE",
            "gender": "FEMALE",
            "birthday": "1990-10-25",
            "contact": [
                {
                    "contactType": "primaryPhone",
                    "contactInformation": "7799885566"
                }
            ],
            "address": {
                "zipCode": "6",
                "street": "Rua ",
                "number": "123",
                "neighborhood": "Bairro",
                "city": "Uberlandia",
                "state": "MG"
            },
            "documentsTempFiles": {
                "holderFiles": [ 
                    {
                     "documentType":"cpf",
                     "url":"https://ctn-global-develop.s3.amazonaws.com/documents/files_temp/2024-02-16/cpf.jpg"
                    }
                ]
            }
        },
        "salesPromoter": "BRABC12345",
        "payment": {
            "paymentType": "creditCard",
            "creditCard": {
                "holder": "Frederica Fefefifa",
                "number": "4111111111111111",
                "cvv": "123",
                "expirationDate": "2025-09",
                "brand": "visa",
                "installments": 1
            }
        }
    }
}

Example Request
201 Created

View More
curl


curl --location 'https://api.global.sistematodos.com.br/homolog/affiliates' \
--data-raw '{
    "createPersons": {
        "holder": {
            "name": "Maria Marilidia",
            "email": "maria@marilidia.com",
            "documents": [
                {
                    "documentType": "cpf",
                    "documentInformation": "70512465002"
                }
            ],
            "maritalStatus": "SINGLE",
            "gender": "FEMALE",
            "birthday": "1990-10-25",
            "contact": [
                {
                    "contactType": "primaryPhone",
                    "contactInformation": "7799885566"
                }
            ],
            "address": {
                "zipCode": "6",
                "street": "Rua ",
                "number": "123",
                "neighborhood": "Bairro",
                "city": "Uberlandia",
                "state": "MG"
            },
            "documentsTempFiles": {
                "holderFiles": [ 
                    {
                     "documentType":"cpf",
                     "url":"https://ctn-global-develop.s3.amazonaws.com/documents/files_temp/2024-02-06/cpf.jpg"
                    }
                ]
            }
        },
        "salesPromoter": "BRABC12345",
        "payment": {
            "paymentType": "creditCard",
            "creditCard": {
                "holder": "Frederica Fefefifa",
                "number": "4111111111111111",
                "cvv": "123",
                "expirationDate": "2025-09",
                "brand": "visa",
                "installments": 1
            }
        }
    }
}'

201 Created
Example Response
 * Body
 * Headers (12)

json


{
  "franchise": "FRA#BR1AB2C3D4",
  "financialResponsible": "IDU#BRCCV20506",
  "contract": "CON#BRNTOY5DMXX9",
  "holder": "IDU#BRCCV20506",
  "dependents": [],
  "salesPromoter": "IDU#BRABC12345"
}

Content-Type

application/json

Content-Length

176

Connection

keep-alive

Date

Fri, 16 Feb 2024 11:00:48 GMT

x-amzn-RequestId

f8bfeff0-5109-4b5f-b3c3-aa5bb7b45092

Access-Control-Allow-Origin

*

x-amz-apigw-id

TOb8JGtEoAMEBfw=

X-Amzn-Trace-Id

Root=1-65cf404d-649147eb672bba4141e4be2f

X-Cache

Miss from cloudfront

Via

1.1 8531211c6acf3e72430606e880d034ac.cloudfront.net (CloudFront)

X-Amz-Cf-Pop

GIG51-P2

X-Amz-Cf-Id

JzA4l4zoW4KfLT6HiKXMQhll_dgGqoMV6DAHYq0aHvD6HPF7aUcHXg==