Histórico da Página

...

Todas as APIs já desenvolvidas podem ser encontradas em nosso repositório do GitHub.

 Retornar ao Fluxograma de Criação de Integrações

Diferenciação entre API e Schema

...

• x-totvs dentro dos verbos dos "paths"

  O exemplo a seguir também é um trecho da API UnitOfMeasure v2.

  Expandir
  title Expandir exemplo
  Bloco de código (...) "paths": { "/UnitOfMeasures": { "get": { "tags": [ "UnitOfMeasures" ], "summary": "Retorna lista de Unidade de Medida", "x-totvs": { "productInformation": [ { "product": "Protheus", "available": true, "note": "Este verbo esta disponivel com todos os parametros", "minimalVersion": "12.1.21" }, { "product": "Logix", "available": true, "note": "Este verbo esta disponivel com todos os parametros", "minimalVersion": "12.1.23" } ] } (...)

Diferentemente dos do x-totvs da "info",  a propriedade "messageDocumentation" não está presente nos x-totvs dos "paths".

...

• • product: produto ao qual aquelas informações do "productInformation" se referem;
  • available: campo booleano que indicia de o verbo esta implementado no produto;
  • note: observações sobre o verbo referente ao produto, como regras específicas;
  • minimalVersion: a versão minima na qual o verbo foi implementado no produto.
    
    

 Retornar ao Fluxograma de Criação de Integrações

Identificar se o produto a ser integrado já está definido na documentação da API

O API Reference é um portal que obtém os dados do JSON da API e os transfere para uma interface visual, tornando a navegação pelas APIs mais atrativa aos usuários.   Para identificar quais produtos estão adaptados a uma determinada API, basta acessar o API Reference e identificar quais os produtos que se encontram explicitados (como demonstra a animação abaixo).

...

Como evidenciado no GIF o usuário pode, se preferir, acessar diretamente o arquivo OpenAPI e indentificar no próprio JSON se as tags x-totvs especificam o produto procurado.

 Retornar ao Fluxograma de Criação de Integrações

Editar "x-totvs" da API

<Tópico pendente de informação>

Caso a api API já exista mas , porém não para seu o produto desejado pelo usuário, significa que você precisa aadaptar há necessidade de adaptar a API ao seu produto.para que o produto em questão passe a ser especificado.

<Tópico pendente de informação>

Adicionar novo produto, especificação de adapters etc etc

deve ser adicionado no info, nos paths e também schema 

 Retornar ao Fluxograma de Criação de Integrações