Artigos de Docs & Getting Started

Docs & Getting Started 1,171 What an API is, in plain words: requests, answers and a REST example The short answer: an API is the agreed way for one program to ask another for something. Instead of a person opening...
Docs & Getting Started 117 Our API documentation: what it is, who it is for and how to find it The short answer: the API documentation is the site where we explain, page by page, how to connect your own programs...
Docs & Getting Started 120 How our API documentation is organised: Get started, Areas, API reference and Playground The short answer: the side menu of the documentation has four groups. Get started explains the rules that apply to...
Docs & Getting Started 102 A reading path through our API docs: from the first request to a finished integration The short answer: you do not have to read the whole documentation. For an integration that works and does not break...
Docs & Getting Started 176 Searching our API documentation: Ctrl+K, the slash key, results by section and recent searches The short answer: there is a search box in the side menu and another on the home page. On any page, Ctrl+K (Cmd+K on...
Docs & Getting Started 105 Reading an area page in our API docs: the guide on top, the operations below and the filter The short answer: each API area (Domains, DNS, SMS, Invoices and credit, and the rest) has a page with two parts. At...
Docs & Getting Started 105 Reading one API operation in our docs: permission, parameters, examples, responses and errors The short answer: every operation in the documentation has the same sections, in the same order: Authentication,...
Docs & Getting Started 115 Every page of our API docs in Markdown: View as Markdown, Copy page and what they are for The short answer: every page of the documentation also exists in Markdown, plain text with light formatting. At the...
Docs & Getting Started 170 Our API docs and AI tools: the llms.txt file and giving an assistant the whole documentation The short answer: at the root of the documentation there is an llms.txt file: a plain-text index of every page, in...
Docs & Getting Started 127 Summarise with AI and Share in our API docs: what the buttons do and when to trust the answer The short answer: at the top of the documentation pages there is a "Summarize with AI" row, with buttons for...
Docs & Getting Started 104 Our API docs in Portuguese or English: where each language lives and how to switch The short answer: the whole documentation exists in English and Portuguese, page by page. The language selector at...
Docs & Getting Started 94 From the API docs to your account panel and back: the API page, keys and support The short answer: the documentation explains; My MozOut is where you act. API keys are created, listed and revoked...
Docs & Getting Started 134 Handing our API docs to a developer or agency: section links, Markdown and the specification The short answer: you do not need to explain the API to whoever is programming. Just send the right links: the start...