Skip to main content

Using Payaca's API: A step-by-step guide

A step-by-step guide to using Payaca's API to allow you to build efficient workflows between other applications and Payaca.

Written by Matt Franklin
Updated over 10 months ago

1. Introduction to Payaca's API 0:00

generated-image-at-00:00:00

  • Payaca's API facilitates data exchange with other applications.

  • Enables integration with your website for customer data submission and project generation.


2. Subscription Requirement 0:14

generated-image-at-00:00:14

  • A growth subscription or higher is required to access the API.


3. Generating API Keys 0:24

generated-image-at-00:00:24

  • Navigate to 'My Company' > 'Integrations' to generate API keys.

  • Click 'Create Key' and name it (e.g., 'demo').

  • Copy the secret key immediately as it is only shown once.


4. Storing API Keys Securely 1:04

generated-image-at-00:01:04

  • Store the secret key securely in a password management system.

  • If lost, you will need to create a new key.


5. Sharing API Keys 1:19

generated-image-at-00:01:19

  • When sharing with developers, provide both the client ID and secret key securely.


6. Accessing API Documentation 1:51

generated-image-at-00:01:51

  • Access the API documentation linked in the integrations section.

  • Documentation includes jump links and a search box for easy navigation.


7. Understanding API Functionality 2:06

generated-image-at-00:02:06

  • Documentation covers creating and updating customers, including required requests and responses.

  • Examples provided for posting new information to customer endpoints.


8. Advanced API Features 3:00

generated-image-at-00:03:00

  • Create custom field sets for projects or customers (e.g., solar survey data).

  • Use API to add project notes and create proposals.


9. Encouragement for Feedback 3:33

generated-image-at-00:03:33

  • Developers are encouraged to provide feedback on API usage and suggest additional functionalities.


10. Conclusion and Next Steps 3:55

generated-image-at-00:03:55

  • Go to the integration section to get your API key and check out the documentation.

  • Good luck with your API integration!

Link to full video

Link to API documentation

Did this answer your question?