Pular para o conteúdo principal

OpenAPI

As especificações são a fonte da verdade da integração. Portal, coleção Postman e SDKs são todos derivados delas.

Download

EspecificaçãoImplementaArquivo
Partner PDV API v1.0PDV Parceiropartner-pdv-api.v1.yaml
Sales Authorization API v1.0Levfonelevfone-authorization-api.v1.yaml

Formato OpenAPI 3.1.0. Ambos validam contra o schema oficial.

Validação

pip install openapi-spec-validator
python -c "
from openapi_spec_validator import validate
from openapi_spec_validator.readers import read_from_filename
validate(read_from_filename('partner-pdv-api.v1.yaml')[0])
print('OK')
"

Geração de cliente

# TypeScript
npx @openapitools/openapi-generator-cli generate \
-i partner-pdv-api.v1.yaml \
-g typescript-axios \
-o ./sdk/typescript

# Java
npx @openapitools/openapi-generator-cli generate \
-i partner-pdv-api.v1.yaml \
-g java \
--library okhttp-gson \
-o ./sdk/java

# C#
npx @openapitools/openapi-generator-cli generate \
-i partner-pdv-api.v1.yaml \
-g csharp \
-o ./sdk/csharp
Verifique o mapeamento de Money

Alguns geradores mapeiam amount para tipo de ponto flutuante mesmo quando o schema declara integer. Confira o tipo gerado antes de usar: um double aqui reintroduz exatamente o problema que o inteiro em centavos existe para evitar.

Geração de mock server

Útil para o parceiro desenvolver antes de a Levfone estar pronta, e vice-versa.

npx @stoplight/prism-cli mock partner-pdv-api.v1.yaml --port 4010

O Prism responde com os exemplos declarados na especificação e valida as requisições contra os schemas — o que torna o mock também um teste de contrato.