API
Verificando conta Raims

Contrato OpenAPI

Baixe ou importe o contrato público da API Raims.

O repositório raimshq/openapi publica o contrato OpenAPI da versão da API Raims disponível para integrações. Use esse contrato para consultar a estrutura dos endpoints, importar a referência em uma ferramenta compatível ou gerar um cliente para o seu projeto.

O diretório latest acompanha a versão efetivamente publicada da API. Ele não antecipa mudanças que ainda estejam somente no código-fonte.

Escolher o arquivo para cada etapa

ArtefatoQuando usarO que acontece ao atualizar
openapi.spec3.json ou openapi.spec3.yamlImportar a referência ou alimentar um gerador.Um novo download traz o contrato publicado atual.
Cliente em ./generated/raimsFazer chamadas pela biblioteca gerada no seu projeto.Execute o gerador de novo e revise o código; baixar o contrato sozinho não altera esse diretório.
Credencial da integraçãoAutenticar as chamadas feitas pela ferramenta ou aplicação.Configure-a separadamente; o contrato não contém chaves.
  1. Baixar o contrato

    Use um dos arquivos abaixo. JSON e YAML descrevem os mesmos endpoints.

  2. Importar ou gerar

    Importe a URL na ferramenta ou use o arquivo local como entrada do gerador. No comando desta página, substitua SEU_GERADOR pela opção da sua linguagem.

  3. Conferir a integração

    Revise a diferença no código gerado e teste com Sandbox antes de usar a atualização na aplicação. Comece pela primeira consulta.

Arquivos disponíveis

Os dois arquivos descrevem o mesmo contrato. Escolha o formato aceito pela sua ferramenta.

Baixar ou importar

Para baixar o JSON:

Shell
curl --fail --location --output openapi.spec3.json https://cdn.raims.com/downloads/openapi/latest/openapi.spec3.json

No Postman, Insomnia ou outra ferramenta compatível com OpenAPI 3, escolha a importação por URL e informe o endereço do arquivo JSON ou YAML. Se a ferramenta aceitar somente arquivos locais, baixe um deles e faça a importação pelo disco.

O contrato descreve a autenticação Bearer, mas não contém credenciais. Configure sua chave no ambiente seguro da ferramenta e não a grave na coleção exportada.

Gerar um cliente

Use o arquivo baixado como entrada de um gerador compatível com OpenAPI 3. Por exemplo, com o OpenAPI Generator CLI:

Shell
openapi-generator-cli generate \
  -i openapi.spec3.json \
  -g SEU_GERADOR \
  -o ./generated/raims

Escolha o gerador da linguagem e da biblioteca usadas no seu projeto. Revise o código gerado, mantenha a configuração do gerador versionada e execute os testes da integração antes de atualizar sua aplicação. Esse cliente pertence ao seu projeto e não é um SDK oficial da Raims.

Manter o contrato atualizado

Use os endereços desta página para baixar o contrato atual, inclusive em geração de código e CI. Baixe o arquivo novamente antes de gerar o cliente para acompanhar a versão publicada da API.

Revise as diferenças do contrato, regenere o cliente e execute os testes da integração antes de atualizar sua aplicação. Um novo download não altera automaticamente o código já gerado no seu projeto.