AdvPlan

AdvPlan Documentos API

Documentos do caso e geração a partir de modelos

GitHub OpenAPI

Operations 6

GET /api/v1/documentos Lista documentos #
GET /api/v1/documentos/{documento} Mostra os dados de um documento #
DELETE /api/v1/documentos/{documento} Remove um documento #
POST /api/v1/documentos/gerar Gera um documento a partir de um modelo #
GET /api/v1/documentos/{documento}/download Baixa o arquivo do documento #
GET /api/v1/documentos/{documento}/texto Devolve o texto do documento #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/advplan-com-br/openapi/advplan-com-br-documentos-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/advplan-com-br:advplan-com-br-documentos-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

advplan-com-br-documentos-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Advplan Com Br Documentos API
  version: 1.0.0
  contact:
    name: Suporte AdvPlan
    email: contato@advplan.com.br
  description: 'Operations tagged Documentos across 2 of this provider''s published API definitions: advplan-com-br-openapi.json, advplan-com-br-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://lp.advplan.com.br
  description: Este ambiente (o que você está lendo agora)
tags:
- name: Documentos
  description: Documentos do caso e geração a partir de modelos
paths:
  /api/v1/documentos:
    get:
      tags:
      - Documentos
      summary: Lista documentos
      operationId: e5ee7c2cf84a8db11aa3fd0a29f7478b
      parameters:
      - name: caso_id
        in: query
        schema:
          type: integer
      - name: cliente_id
        in: query
        schema:
          type: integer
      - name: busca
        in: query
        description: Palavras do nome; cada uma precisa estar nele
        schema:
          type: string
      - name: criado_de
        in: query
        schema:
          type: string
          format: date
      - name: criado_ate
        in: query
        schema:
          type: string
          format: date
      - name: status_assinatura
        in: query
        description: pendente, enviado, visualizado, assinado, recusado (separados por vírgula)
        schema:
          type: string
      responses:
        '200':
          description: Lista paginada de documentos
      security:
      - chaveDoEscritorio: []
    servers:
    - url: https://lp.advplan.com.br
      description: Este ambiente (o que você está lendo agora)
  /api/v1/documentos/{documento}:
    get:
      tags:
      - Documentos
      summary: Mostra os dados de um documento
      operationId: 6c95ba4002cd987c31604a992599a692
      parameters:
      - name: documento
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Documento
        '404':
          description: Não existe, ou é de outro escritório
      security:
      - chaveDoEscritorio: []
    delete:
      tags:
      - Documentos
      summary: Remove um documento
      operationId: afaff6fa23120f8930ca927a97956196
      parameters:
      - name: documento
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Documento removido
        '403':
          description: A chave não tem permissão de excluir documentos
        '404':
          description: Não existe, ou é de outro escritório
      security:
      - chaveDoEscritorio: []
    servers:
    - url: https://lp.advplan.com.br
      description: Este ambiente (o que você está lendo agora)
  /api/v1/documentos/gerar:
    post:
      tags:
      - Documentos
      summary: Gera um documento a partir de um modelo
      description: As variáveis do modelo são preenchidas com os dados do cliente e do caso informados. O documento nasce como rascunho, para revisão.
      operationId: b2aa5a339646c062782766b34ae44b49
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - template_id
              properties:
                template_id:
                  type: integer
                  example: 12
                cliente_id:
                  type: integer
                  example: 34
                caso_id:
                  type: integer
                  example: 56
                extras:
                  description: Variáveis personalizadas do modelo
                  type: object
                  example:
                    valor_honorarios: '5000'
              type: object
      responses:
        '200':
          description: Documento gerado
        '422':
          description: Modelo inexistente ou variável obrigatória faltando
      security:
      - chaveDoEscritorio: []
    servers:
    - url: https://lp.advplan.com.br
      description: Este ambiente (o que você está lendo agora)
  /api/v1/documentos/{documento}/download:
    get:
      tags:
      - Documentos
      summary: Baixa o arquivo do documento
      operationId: 6003682a7de69cd7478995395a2e1fbb
      parameters:
      - name: documento
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: O arquivo, com o tipo original
        '404':
          description: Não existe, ou é de outro escritório
      security:
      - chaveDoEscritorio: []
    servers:
    - url: https://lp.advplan.com.br
      description: Este ambiente (o que você está lendo agora)
  /api/v1/documentos/{documento}/texto:
    get:
      tags:
      - Documentos
      summary: Devolve o texto do documento
      description: PDF, Word e imagem passam por extração e OCR. Útil para IA e automação que não abrem o binário.
      operationId: 1cf2d545c8af4fc87f214c4468fe5d5b
      parameters:
      - name: documento
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: '{data: {id, nome, texto}}'
        '404':
          description: Não existe, ou é de outro escritório
      security:
      - chaveDoEscritorio: []
    servers:
    - url: https://lp.advplan.com.br
      description: Este ambiente (o que você está lendo agora)
components:
  securitySchemes:
    chaveDoEscritorio:
      type: http
      description: 'Cole a chave criada em Configurações → Chaves de API. No cabeçalho vai como: Authorization: Bearer SUA_CHAVE'
      scheme: bearer
x-refined-from:
- advplan-com-br-openapi.json
- advplan-com-br-openapi.json