{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/oneplatform/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API & Integration","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api--integration","__idx":0},"children":["API & Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["One Platform API documentation is organized into two API families with different audiences and access rules."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API family"},"children":["API family"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Audience"},"children":["Audience"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint reference"},"children":["Endpoint reference"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/overview"},"children":["Organizations API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partners and customer-side system integrators working in an organization scope."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/apis/oas/organizations"},"children":["Organizations API endpoints"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/integrators-api/overview"},"children":["Integrators API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Namirial product integrators and internal product integrations."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/apis/oas/integrators"},"children":["Integrators API endpoints"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"organizations-api","__idx":1},"children":["Organizations API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Organizations API when the integration acts on behalf of a One Platform organization. Most operations are scoped by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organizationId"]}," and use routes such as:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"/v1/organizations/{id}/<resource>\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start from:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/authentication"},"children":["Organizations API Authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/overview"},"children":["Organizations API Overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/organizations-api/integration-guides/overview"},"children":["Organizations API Integration Guides"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integrators-api","__idx":2},"children":["Integrators API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Integrators API for integrations reserved to Namirial product teams and approved Namirial integrators. This family exposes broader integration endpoints and is protected by dedicated RBAC."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Start from:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/integrators-api/authentication"},"children":["Integrators API Authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/integrators-api/overview"},"children":["Integrators API Overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/integrators-api/integration-guides/overview"},"children":["Integrators API Integration Guides"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"provisioning","__idx":3},"children":["Provisioning"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provisioning documents the dry-run and activation callbacks that One Platform sends to integrated Namirial products during service activation."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/provisioning"},"children":["Provisioning"]}]}]}]},"headings":[{"value":"API & Integration","id":"api--integration","depth":1},{"value":"Organizations API","id":"organizations-api","depth":2},{"value":"Integrators API","id":"integrators-api","depth":2},{"value":"Provisioning","id":"provisioning","depth":2}],"frontmatter":{"seo":{"title":"API & Integration"}},"lastModified":"2026-06-11T14:29:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/oneplatform/one-platform-knowledge-center/04-api-and-integration/api-integration-overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}