Enterprise onboarding in Apidog moves through three phases: secure access, API data migration, and workflow adoption. Complete each checkpoint before expanding to more users, Projects, or workflows.If your implementation team is new to Apidog's Organization, Team, and Project structure, review Basic Concepts first.
Apidog On-PremisesApidog runs on your infrastructure and can differ slightly in feature availability. Use the self-hosting documentation for deployment and configuration, and Apidog Docs for shared features.
Apidog is available as a desktop application for Windows, macOS, and Linux, or as the Apidog web application. Work with your IT team to approve the desktop application and required network access before onboarding users.
Network proxy: If your organization connects through a proxy, obtain the connection details from your IT team. After signing in, open ⚙ Settings > Proxy from the top-right corner. Before signing in, use Proxy Settings in the bottom-left corner of the desktop application's login screen.
Firewall allowlist: Allow connections to *.apidog.com and *.apidog.io so Apidog can synchronize cloud data and provide its online features.
Two different proxy configurations
The client proxy setting above connects Apidog to its cloud services. A Request Proxy Agent is configured separately when users need Apidog to send requests to APIs inside a private network.
Secure enterprise accessChoose how users join, authenticate, and receive Team and Project access.Checkpoint: Representative users have the intended access.
Establish the team's workflowValidate the real work the team will complete in Apidog.Checkpoint: Representative users can complete the agreed workflow.
Select the initial Team Admin. When this person creates the Team, they become its Team Owner and can manage Team information, Projects, members, permissions, billing, ownership transfer, and Team dissolution. Additional Team Admins can help manage members.
Permissions
Team roles—Owner, Admin, Member, and Guest—govern the Team. Project roles—Admin, Editor, Read-only, and Forbidden—govern access to each Project. A Team can contain multiple Projects with different permissions for each member.
Projects and migration
Create one pilot Project with an appropriate name, description, template, and Project mode. Then use Project Settings > Import Data to import OpenAPI/Swagger, Postman, or another supported format. Project mode cannot be changed after creation.
Initial configuration
Review Team name, description, and avatar; Project name, description, and default environment; environment variables; and notification settings.
Choose direct invitations or SSO for user access, and add SCIM when supported provisioning and deprovisioning are required. Validate the imported paths, methods, schemas, examples, authorization, environments, variables, scripts, and tests that the pilot team relies on.
If users need Apidog to reach private APIs, deploy a Request Proxy Agent and add it at the Organization level under Organization Settings > Organization Resources. This is separate from the client proxy used to connect to Apidog. For background on where requests are sent and processed, see Request Routing and Data Security.
