> For the complete documentation index, see [llms.txt](https://docs.saferpay.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.saferpay.com/home/integration-guide/guides-for-solution-developers.md).

# Guides for solution developers

This part of our guide is targeted towards solution developers, that want to integrate Saferpay into their software, or build a plug-in for a shop system etc.

Due to that, it will cover best practices and checklists, that are targeted towards user experience, easier onboarding for new merchants and all major Saferpay functions.

It may be too extensive for small, individual integrations, to cover all these points, but it may provide a high level overview over certain areas of Saferpay.

{% hint style="warning" %}
This guide is not meant to replace the normal integration flows, like for instance [the Payment Page](https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/payment-page.md). It is meant to give best practices outside of these flows and a general high-level overview, so nothing crucial is missed during integration.

It will frequently link to the guides themselves, for a more detailed view.
{% endhint %}

## Naming convention

Before we start with integrating anything, it is important to stick to a specific naming convention. Saferpay has names for certain datapoints and functions and they are communicated as such to the merchant. This may sound like a small, unimportant detail, but sticking to certain names is very important to reduce confusion, especially when contacting Saferpay support.

For example:

Calling the CustomerId something else, maybe MerchantId may be logical to you, but for a merchant that has never used your solution, they'll get confused, because they cannot find a MerchantId on Saferpay side, since it is called CustomerId.\
Or calling the JSON API User a Key and the API Password a Secret may also confuse the user.\
Calling the [Payment Page](https://docs.saferpay.com/home/integration-guide/licences-and-interfaces/payment-page.md) anything else, than the Payment Page would also add towards confusion.

Being consistent with Saferpay is key for the merchant to find everything with ease, making the first experiences with Saferpay and also your product feel coherent.

**So please, when naming any input etc. that corresponds to anything on Saferpay side, please stick to this convention.**&#x20;

[Our Glossary will give you an overview over this naming convention](https://docs.saferpay.com/home/master/common-saferpay-terms-glossary.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.saferpay.com/home/integration-guide/guides-for-solution-developers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
