{"openapi":"3.1.0","info":{"title":"WordPane Cloud \u00b7 API do cliente","version":"1.0.0","description":"API restrita \u00e0 conta e aos recursos da credencial. Credenciais nunca retornam senhas de servidores. Datas em UTC. Limite de 60 chamadas\/minuto por integra\u00e7\u00e3o. MCP usa OAuth com PKCE ou token manual; o OAuth do MCP n\u00e3o autoriza estes endpoints REST."},"servers":[{"url":"https:\/\/app.wordpane.cloud\/api\/v1"}],"security":[{"bearerAuth":[]}],"paths":{"\/servers":{"get":{"summary":"Listar servidores","description":"Permiss\u00f5es: servers.read","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Page"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["servers.read"]}},"\/email-domains":{"get":{"summary":"Listar dom\u00ednios","description":"Permiss\u00f5es: emails.read","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Page"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["emails.read"]}},"\/mailboxes":{"get":{"summary":"Listar caixas de e-mail","description":"Permiss\u00f5es: emails.read","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Page"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["emails.read"]}},"\/tickets":{"get":{"summary":"Listar chamados","description":"Permiss\u00f5es: tickets.read","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Page"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["tickets.read"]}},"\/servers\/{id}":{"get":{"summary":"Detalhes do servidor","description":"Permiss\u00f5es: servers.read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Item"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["servers.read"]}},"\/servers\/{id}\/installation":{"get":{"summary":"Estado registrado da instala\u00e7\u00e3o","description":"Permiss\u00f5es: servers.read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Item"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["servers.read"]}},"\/email-domains\/{id}\/mailboxes":{"get":{"summary":"Caixas do dom\u00ednio","description":"Permiss\u00f5es: emails.read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Page"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["emails.read"]}},"\/tickets\/{id}":{"get":{"summary":"Detalhes do chamado","description":"Permiss\u00f5es: tickets.read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Item"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["tickets.read"]}},"\/tickets\/{id}\/messages":{"get":{"summary":"Mensagens do chamado","description":"Permiss\u00f5es: tickets.read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Page"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["tickets.read"]},"post":{"summary":"Responder chamado sem duplicar envios","description":"Permiss\u00f5es: tickets.read tickets.reply","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","minimum":1}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":16,"maxLength":100,"pattern":"^[a-zA-Z0-9_-]+$"}}],"responses":{"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"201":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Item"}}}},"409":{"description":"Chamado fechado ou conflito de idempot\u00eancia"}},"x-wordpane-scopes":["tickets.read","tickets.reply"],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["reply"],"properties":{"reply":{"type":"string","minLength":1,"maxLength":10000},"in_reply_to_id":{"type":"integer","minimum":1}}}}}}}},"\/balance":{"get":{"summary":"Saldo da conta inteira em BRL","description":"Permiss\u00f5es: billing.read","parameters":[],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Item"}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["billing.read"]}},"\/ledger":{"get":{"summary":"Extrato da conta inteira","description":"Permiss\u00f5es: billing.read","parameters":[{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"search","in":"query","schema":{"type":"string","maxLength":100}},{"name":"month","in":"query","schema":{"type":"integer","minimum":1,"maximum":12}},{"name":"year","in":"query","schema":{"type":"integer","minimum":2020,"maximum":2100}}],"responses":{"200":{"description":"Consulta conclu\u00edda","content":{"application\/json":{"schema":{"type":"object","required":["entries","total","timezone"],"properties":{"entries":{"type":"object","description":"Pagina\u00e7\u00e3o Laravel de lan\u00e7amentos"},"total":{"type":"number"},"timezone":{"type":"string"}}}}}},"401":{"description":"Credencial inv\u00e1lida","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Permiss\u00e3o insuficiente","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Recurso indispon\u00edvel","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Par\u00e2metros inv\u00e1lidos","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Limite atingido","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"x-wordpane-scopes":["billing.read"]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Credencial wp_live_ gerada em Conta \u2192 API e integra\u00e7\u00f5es."}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object"}}},"Page":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"type":"object","required":["current_page","last_page","per_page","total"],"properties":{"current_page":{"type":"integer"},"last_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"}}}}},"Item":{"type":"object","properties":{"data":{"type":"object"}}}}}}