neri

IntroduçãoCopied!

Esta documentação vai te ajudar a construir uma integração conosco e a atingir automação em algumas das funcionalidades da neri.

Como este documento está organizadoCopied!

Este documento prepara o terreno para te auxiliar na integração com a neri, passando por todas as etapas que representam as melhores práticas para se integrar conosco.

A estrutura passa inicialmente por um “Hello World”, com os pré-requisitos necessários para conseguir acessar as informações da plataforma.

O “Hello World”Copied!

1. Ambiente de homologação

   Você precisará criar uma conta no ambiente de homologação, para isso, basta acessar https://homologacao.neri.care, e criar sua conta.

   Uma vez que seu usuário esteja criado, faça login, você deve ser direcionado à home do nosso ambiente de homologação.

   [Placeholder-Foto-Home]

   Na área logada, clique no seu perfil e selecione “Chaves de API”, se a integração for para um meio corporativo, selecione a opção “Chaves de API” de dentro do perfil da empresa.

   [Placeholder-menu-chave-api]

   Selecione a opção “Criar nova chave”, defina a validade da mesma, e copie a chave para um lugar seguro. Não compartilhe esta chave com ninguém, ela representa o seu usuário, e toda movimentação utilizando-a será feita em seu nome.

   [Placeholder-chave-api-copiada]

2. Autenticação

   Nossa estrutura de autenticação utiliza OAuth, assim, a chave de API gerada anteriormente, deverá ser passada para qualquer requisição do ambiente, afim de autenticar que o usuário que está realizando a requisição pode ter efetivamente acesso aos dados que está buscando ou inserindo.

   Lembrando que a chave de api gerada no passo anterior é para o nosso ambiente de homologação. Com sua chave de API em mãos, toda requisição feita ao ambiente de homologação, através de https://hml-api.neri.care deverá ser feita utilizando este token, informado no header da requisição.

POST /method HTTP/1.1
Accept: application/json
Authorization: Bearer CHAVE-DE-API-GERADA
Content-Type: application/json

{
	"test":{ "testField":"testData"}
} 

/