Brikl — API Docs

Brikl's Developer Portal (opens in a new tab) was developed to facilitate integrating Brikl's e-commerce platform with third-party applications. The API Docs empowered customers to feed CRM, ERP, and other back-office applications with shop data, enabling them to generate reports and gain valuable business insights.

Problems

Before the introduction of the developer portal, Brikl and its customers faced the following challenges:

• Lack of API documentation hindered the integration of Brikl with third-party applications.
• Dependence on Brikl for integrations resulted in prolonged wait times and limited control over data synchronization processes.
• Brikl had to allocate its development team to handle customer integrations, impeding the speed of new product feature development.
• Unfamiliarity with GraphQL posed a learning curve for customers.

Contributions

As a technical writer, I addressed the problems described above by:

• Crafting comprehensive API docs that granted customers autonomy to retrieve and utilize shop data for various business purposes.
• Published a series of technical articles on GraphQL with practical examples and code samples that used Brikl's API. See GraphQL Tutorials.

Impacts

My contributions yielded significant positive impacts:

• Enhanced customer experience through clear documentation, reducing confusion and accelerating integrations.
• Decreased support requests related to integration tasks, improving customer satisfaction and minimizing the support burden.
• Alleviated the company's workload by providing customers with a self-service approach to retrieve data from Brikl's platform and perform integration tasks autonomously.

Link

Project link: https://developers.brikl.com/ (opens in a new tab)