Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Contas (Account Opening) Accounts API

4 actions 4 updates phrasing extends openapi/gerencianet-accounts-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Efí Pay (Gerencianet)'s API. It is a proposal applied on top of the contract, not a document Efí Pay (Gerencianet) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/conta-simplificada'].post
$.paths['/conta-simplificada/{identificador}/certificado'].post
$.paths['/conta-simplificada/{identificador}/credenciais'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Efí Pay Contas (Account Opening) Accounts API
  version: 1.0.0
extends: openapi/gerencianet-accounts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/conta-simplificada'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a simplified account
      effect: write
      questions:
      - How do I open a simplified account for one of my customers?
      - Can I create a simplified Efí account through the API?
      instructions:
      - text: Create a new simplified account.
      - text: Open a simplified account for a new customer.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/conta-simplificada/{identificador}/certificado'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a certificate for a simplified account
      effect: write
      questions:
      - Can I generate the API certificate for a simplified account I opened?
      - What do I call to issue a certificate for an account's integration?
      instructions:
      - text: Generate a certificate for simplified account {identificador}.
        slots:
          identificador: path.identificador
      - text: Issue a new API certificate for account {identificador}.
        slots:
          identificador: path.identificador
      method: generated
      generated: '2026-10-01'
- target: $.paths['/conta-simplificada/{identificador}/credenciais'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a simplified account's API credentials
      effect: read
      questions:
      - Where do I get the client credentials for a simplified account?
      - Can I retrieve the API keys of an account I created for a customer?
      instructions:
      - text: Get the credentials for simplified account {identificador}.
        slots:
          identificador: path.identificador
      - text: Fetch the client id and secret for account {identificador}.
        slots:
          identificador: path.identificador
      method: generated
      generated: '2026-10-01'