A Interage API disponibiliza recursos para a criação de funcionalidades relacionadas a interações entre medicamentos. A API possui URLs orientadas a recursos e utiliza metódos HTTP para interagir com os recursos da API como definido pelo modelo REST. A API fornece quatro recursos: Princípios Ativos, Medicamentos, Apresentação de Medicamentos e Interações.

Você pode consultar os recursos através da URL raiz api.interage.intmed.com.br/v1/. Todas as URLs da API possuem uma "/" no final.

Você deve incluir no cabeçalho HTTP Authorization da requisição a palavra Token seguida da sua chave para ter acesso aos recursos da API. Exemplo:

Você pode visualizar e gerenciar sua chave através desta interface web. Outra maneira de obter sua chave é através de uma requisição POST para a url /obter-chave/ passando no corpo da requisiçãos os campos username e password. Exemplo:

A Interage API fornece uma interface WEB para que você se familiarize com os recursos da API. Através desta interface é possível examinar as respostas HTTP às requisicões feitas, testar os parâmetros da URL e etc. É necessário fazer login no Interage para ter acesso.

URLs que retornam mais de um objeto são paginadas. O parâmetro ?page= determina qual página será acessada e o parâmetro ?page_size= quantos objetos serão mostrados por página. O valor padrão de objetos exibidos por página é 100 e o máximo é 200.

Respostas paginadas possuem os seguintes atributos:

• count: quantidade de objetos retornado.
• next: próxima página com resultados.
• previous: página anterior com resultados.
• results: array com os objetos retornados.

A Interage API utiliza Versionamento Semântico. A atual versão MAIOR é 1.Y.Z e fica explícita na URL (v1/). Todas as alteração feitas na versão MAIOR serão compatíveis. As respostas retornam a versão MENOR mais recente. Se por alguma razão extraordinária esta compatibilidade não puder ser mantida, os clientes poderão escolher qual versão MENOR utilizar através do cabeçalho da requisição. Informaremos como Notas da Versão as alterações realizadas em cada versão.

Consideramos alterações compatíveis:

• > Adição de novos recursos
• > Adição de parâmetros opcionais em endpoints existentes
• > Adição de novas propriedades em objetos existentes

A Interage API tem um limite de 500 requisições por minuto.

Caso esse limite se exceda, a API retornará o código de erro HTTP 429 com a mensagem "Pedido foi limitado. Expected available in 58 seconds.".