Planning Your Integration

Before you start using the Cyara API, we recommend planning out which tasks you are looking to perform on your Cyara Portal. This ensures that you find the appropriate API route in our API documentation to perform the function you're looking for.

We recommend examining the following steps to help you determine expense and development time to integrate with the Cyara API. This process will also assist with determining which API routes will be the best choice to perform the tasks you're looking for.

• Map and document business processes that require automating or scaling.
• Identify any pain points in these business processes.
• Detail the business needs for the integration.
  • These business needs include the time and cost to integrate processes with the API.
  • The number and type of platforms and systems that will be impacted.
  • The internal processing logic of each business system.
  • The number of APIs to be integrated.
  • Identify appropriate APIs to meet business requirements.
  • Determine developer skill level required.
• A cost benefit analysis, including development and support costs for the integration.

With this plan you are now ready to start using the Cyara API to achieve your business requirements at scale.

Technical Requirements and Specifications

Successfully building integrations to the Cyara API will require a level of technical expertise. The technologies used in the Cyara API that you should be familiar with are as follows;

• REST API Methodology
• JSON object notation
• Basic programming terminology (Strings, Integers, Booleans etc.)

The Cyara 3.0 API is documented per endpoint in the Swagger Documentation suite, read more about Swagger in the Using Cyara Swagger and the Cyara 3.0 API Article.