Manual de Integração APIs

Seja bem vindo ao manual da API de integração !

Protocolo de Comunicação

Utilizamos uma arquitetura REST como meio de transporte para nossas chamadas, utilizando
protocolo HTTPS.

URL Base de Produção:
https://api.ideiabusiness.com.br/w2b/api/IdeiaSigner/Integracao/

URL Base de Homologação:
https://api.ideiabusiness.com.br/w2b-hlg/api/IdeiaSigner/Integracao/

Segurança

Utilizamos um API token dentro do header das chamadas. Além disso, a url que irá fazer as
requisições deverá estar liberada dentro de nossa política de CORS.

Token

Você precisará de um API Token que deverá ser enviado dentro do header das chamadas feitas a
API. Entre em contato conosco pelo email: suporte.dev@ideiabusiness.com.br para receber seu token.

Local de inserção do token -> Header: Authorization

CORS

Você deverá enviar as URLs base dos sistemas web que se comunicarão com nossa API a fim
de evitar erros de CORS.

Retorno Padrão:

Nossa API encapsula os retornos em um formato de JSON padrão seguindo o exemplo abaixo:

{
    "Success": boolean, // Se a operação deu certo ou não
    "Message": string, // Mensagem sobre o retorno
    "RedirectUrl": string, // Url caso necessite redirecionamento do usuário
    "StatusCode": int, // Status code REST da operação (200 sucesso, 500 erro, 401
    unauthorized)
    "Data": object(json) // JSON com os dados do objeto do retorno
}

Manual de Integração APIs

Protocolo de Comunicação#

Segurança#

Token#

CORS#

Protocolo de Comunicação

Segurança

Token

CORS