This tutorial walks you through registering your application in the Developer Portal, getting it published, and activating it in a Pigello environment so you can generate credentials for authentication.
Once your account is configured with the developer capabilities by Your System Admin or Pigello Contact:
- Open the Developer Portal.
- Log in with your Pigello credentials.
In the Developer Portal you register an application and, under it, one or more services. Applications are initially created as drafts.
Create a new application and fill in the required details (name, description, services, permissions, etc.). Use the How It Works tutorial as a reference for applications, services, and versions.
Tip: During development, set the application to private. A private application is only visible to you (and any accounts you share it with), so you can iterate without exposing an unfinished integration. You can change it to public when you are ready to publish.
Save the application. You can continue editing the application, without having to add new service versions as long as the application is still marked as a draft.
When your application is ready to be visible in Pigello environments:
Ask your contact person at Pigello, or—if you are building through a customer—ask the customer to contact Pigello, to review the application and remove the draft status of it.
Pigello will review the application (e.g. metadata, permissions, and compliance). When it is approved, the application's draft status is removed, and becomes available in the relevant Pigello environment(s).
After the application is no longer a draft:
- In the Developer Portal, open your application and go to the relevant service (or use the application list).
- Use the "Open Integration Link" (or "Open Integration") action. This takes you to the integration's page inside the Pigello environment (e.g. your sandbox or the customer's environment).
There you can see your integration as it appears to users in that environment.
In the Pigello environment:
On the integration page, use the Activate control (typically in the top right corner) to activate the integration for your organization, company, or other scope, depending on the integration's activation level.
Once activated, the integration is available for use in that environment and you can generate credentials for it.
To call the API on behalf of the activated integration:
- Stay on the integration page in the Pigello environment (the same page where you activated it).
- Scroll down to the credentials section.
- Use the option to generate new credentials. These credentials are what you use in your app for authenticating as the integration, towards the activation in question.
| Step | Action |
|---|---|
| 1 | Log in to the Developer Portal with your Pigello account. |
| 2 | Register an application as a draft; consider making it private during development. |
| 3 | Ask your Pigello contact (or the customer to contact Pigello) to review and remove the draft status from the application. |
| 4 | Use "Open Integration Link" in the Developer Portal to open the integration in the Pigello environment. |
| 5 | Activate the integration (e.g. in the top right) in the Pigello environment. |
| 6 | On the integration page, scroll down and generate new credentials. |