Organizations

Provisioning organizations

OpenGate Organization API: Central Management Hub

Welcome to the comprehensive documentation of the OpenGate Organization API, a critical component of the OpenGate IoT platform by Amplía Soluciones. As defined in the OpenAPI 3.0.0 specification, this API is pivotal for the holistic management of OpenGate organizations, the highest-level and most crucial entities within the OpenGate platform.

The Role of Organizations in OpenGate

  • Foundation of IoT Ecosystem: In OpenGate, an organization is the root entity from which all other entities branch out. Those entities include users, devices, assets, channels (device groups), work groups, and sub-organizations.
  • Central Control and Coordination Point: Managing an organization through this API allows you to control and coordinate the entire spectrum of your IoT infrastructure effectively within the OpenGate ecosystem.

Organizations Organizations

Key Functionalities

  • Comprehensive API Endpoints
    • /north/v80/search/organizations: Facilitates organization searches with customizable formats and filters.
    • /north/v80/search/organizations/summary: Offers summarized data about organizations for quick overviews.
    • /north/v80/provision/organizations: Enables creating new organizations with detailed JSON requests.
    • /north/v80/provision/organizations/{organizationId}: Manages specific organization details, including retrieval, updates, and deletion.

Security and Access

  • Secured Access: Utilizes ApiKeyAmplia and BearerAuthJWT for secure API interactions, ensuring data integrity and confidentiality.
  • Consistent Endpoint: The API services are accessible at https://api.opengate.es, providing a stable and efficient gateway for organizational management.

This API serves as the central nerve system of the OpenGate platform, offering sophisticated tools and interfaces for the administration of Organizations. By mastering this API, users can effectively orchestrate the diverse components of their IoT solutions, ensuring seamless integration and optimal performance of their IoT ecosystem.

Spec