Para se conectar com as APIs da Plataforma, é necessário seguir os seguintes passos:
Em breve iremos atualizar o nosso mecanismo de autenticação para utilizar OAuth2. Recomendamos migrar como parte deste processo para o uso do header Authorization. Veja mais em Autenticação
Entre em contato por meio do formulário abaixo para criar o seu App:
Após o envio do formulário, iremos avaliar a sua submissão e na sequência criar o ambiente para desenvolvimento e homologação. Este processo pode levar alguns dias. Lembre-se de deixar seu contato pois pode ser necessário obter mais detalhes sobre a sua submissão.
Para realizar a implementação, recomendamos utilizar o Swagger Codegen para criar o cliente de API na linguagem de programação de sua escolha. Para seu ambiente de integração contínua, recomendamos utilizar mocks das chamadas de API.
Para os testes de integração/aceitação, você pode usar o token de desenvolvimento disponibilizado ao criar seu app e o nosso ambiente de homologação. Na homologação, é possível “forçar” cenários informando valores específicos no input, por exemplo, para validar seu tratamento de erros.
Após testar seu app e obter o resultado esperado no ambiente de homologação, é chegada a hora de implantar em produção e dividir com seus usuários. Recomendamos como boa prática o rollout gradual, quando possível.
Após finalizar a integração solicite com o seu representante a liberação para acesso em produção. Você é responsável pelo zelo do suas credenciais de produção: é importante zelar para que ela seja armazenada em local seguro.