Skip to content

Commit 64089b2

Browse files
author
Christoph Apke
committed
Revision of the partner process pages
1 parent 8eee1a4 commit 64089b2

File tree

7 files changed

+828
-30
lines changed

7 files changed

+828
-30
lines changed

modules/ROOT/assets/images/partner-process/integration-steps.svg

Lines changed: 435 additions & 0 deletions
Loading

modules/ROOT/nav.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@
1212
** xref:training.adoc[Training]
1313
1414
* Partner Process
15-
** xref:partner-process/provider-agreement.adoc[Provider Agreement]
15+
** xref:partner-process/legal-agreement.adoc[Legal Agreement]
1616
** xref:partner-process/solutionfinder.adoc[Solution-Finder]
17-
** xref:partner-process/integration-qa.adoc[Integration on QA]
18-
** xref:partner-process/integration-prod.adoc[Integration on Production]
17+
** xref:partner-process/integration-process.adoc[Integration Process]
1918
2019
* xref:integration-steps.adoc[Integration]
2120
** xref:integration/general-conventions.adoc[Conventions]
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
= Development Process
2+
:imagesdir: _images/
3+
4+
== Material
5+
6+
We provide some material to aid during development:
7+
8+
=== SDKs
9+
10+
We provide SDKs for the following languages:
11+
12+
* link:https://github.com/DKE-Data/agrirouter-sdk-java[Java]
13+
* link:https://github.com/DKE-Data/agrirouter-sdk-dotnet-standard[C#/.NET]
14+
* link:https://github.com/DKE-Data/agrirouter-sdk-php[PHP]
15+
* link:https://github.com/DKE-Data/agrirouter-sdk-python[Python]
16+
* link:https://github.com/DKE-Data/agrirouter-sdk-cpp[C++] (3rd party contribution, not officially supported)
17+
18+
All SDKs are open source and their source code hosted on Github.
19+
20+
The SDKs are differing a bit in their range of features. If a certain feature is missing for your language, don't hesitate to contact us or maybe even provide a Pull Request on the respective Github project.
21+
22+
=== agrirouter middleware
23+
24+
There is a 3rd party maintained solution available called the *agrirouter middleware* that further eases some aspects of the agrirouter integration by wrapping the more complex aspects of the agrirouter interface into a simple-to-use REST interface.
25+
26+
For further information, please see link:https://agrirouter-middleware.com[their project].
27+
28+
29+
=== Developer Tutorial
30+
31+
There is a link:https://github.com/DKE-Data/agrirouter-api-developer-tutorial[developer tutorial] available that guides you step-by-step through the development process, using Java as an example.
32+
33+
While the tutorial has already aged a bit, the main concepts are still the same.
34+
35+
=== IO-Tool
36+
37+
We provide a tool that presents an endpoint to communicate with during your integration work. Further information will soon be provided here.
38+
39+
// TODO
40+
//== Development overview
41+
//
42+
//First, you should always keep in mind the xref:../integration/general-conventions.adoc[General conventions].
43+
//
44+
45+
== Support
46+
47+
We are there for you during the whole development process.
48+
49+
Whether you want to discuss your integration architecture approach, are stuck at some point during development, encounter unknown issues etc., just contact us via one of these channels:
50+
51+
* image:icons/email.svg[,24,24] link:mailto:developer-support@my-agrirouter.com[Email/Ticket]
52+
* image:icons/teams.svg[,24,24] link:https://teams.microsoft.com/l/chat/0/0?users=o.rahner%40dke-data.com[Microsoft Teams]
53+
* image:icons/slack.svg[,24,24] link:https://join.slack.com/t/agrirouter/shared_invite/zt-1eubkvbhe-KuP4naHgIOdlciuiXcztGw[Slack]

modules/ROOT/pages/partner-process/integration-prod.adoc renamed to modules/ROOT/pages/partner-process/integration-process.adoc

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,42 @@
33

44
== General process of integration in Production
55

6-
Once the development in the Quality Assurance Environment is finished, you can start to prepare your application for the production environment
6+
image::partner-process/integration-steps.svg[]
77

8-
image::general/process_integration_prod_v2.png[]
8+
== Create developer account
99

10-
== 4.1 Create developer account
10+
include::partial$different-accounts.adoc[]
1111

12-
Once you're done with testing in QA, you can xref:../registration.adoc[create an account in the productive environment].
12+
To start the development, you will need to xref:../registration.adoc[create a developer account].
1313

14-
You can read xref:../accounts.adoc[here] more about the different types of accounts or directly find the URLs for signup xref:../urls.adoc[here].
14+
You can read xref:../accounts.adoc[here] more about the different types of accounts or directly find the URL for signup xref:../urls.adoc[here].
1515

16-
== 4.2 Register & submit your solution
16+
include::partial$approval-manually-support-times.adoc[]
1717

18-
For communication with agrirouter, you need to setup an xref:../applications.adoc[application] in the productive environment.
18+
== Register & submit your solution
1919

20+
For communication with agrirouter, you need to xref:../applications.adoc[setup an application].
2021

21-
== 4.3 Approval from the certification company
22+
Whenever you create a new application version, the agrirouter support team will have to approve this application. Please send an email to support@my-agrirouter.com including the application id and the certification version id to request confirmation. Find out where to find them xref:../ids-and-definitions.adoc[here].
2223

23-
The certification company will perform the certification - with your support - and create a certificate to proof that your solution is compatible with agrirouter.
24+
include::partial$approval-manually-support-times.adoc[]
2425

25-
[IMPORTANT]
26-
====
27-
Please recognize that the certification will be done in the quality assurance environment.
28-
====
26+
== Develop your integration
27+
28+
Please see xref:../development-process.adoc[Development Process].
29+
30+
== Certify your solution
2931

32+
Every app needs to be certified to communicate with the agrirouter. Further information can be found xref:../certification.adoc[here].
3033

31-
== 4.4 Approval from support team
34+
Once you know which kind of application you want to create, you should get in contact with one of the certification companies *early on* to clarify which specific requirements you will have to fulfil to pass the certification.
35+
This will help you to adapt your implementation for the certification and add all requirements for certification.
36+
37+
Make sure to have all xref:../certification.adoc#prerequisites[prerequistes] available.
38+
39+
The certification company will perform the certification - with your support - and create a certificate to prove that your solution is compatible with agrirouter.
40+
41+
== Approval from support team
3242
When the certification is successfully approved, the app will be set to status _Approved_ .
3343

3444
[NOTE]
@@ -37,7 +47,7 @@ If your app is a CU, it will from this point on be visible to all users wanting
3747
====
3848

3949

40-
== 4.5 Test Interface & Messaging
50+
== Test Interface & Messaging
4151

4252
After certification is done, you can test your application in the production environment, which means that you can xref:../invite-testers.adoc[invite real test customers to test the connection in their everyday work] or just ask users to onboard your app (the tester status is not required when your app is _Approved_ but it helps to keep an overview of your testers).
4353

@@ -54,15 +64,13 @@ To connect your app to the production environment, You need to update the follow
5464

5565
The URLS can be found xref:../urls.adoc[here].
5666

57-
5867
[IMPORTANT]
5968
====
6069
Each agrirouter account has a limited number of endpoints, see xref:../limitations.adoc[here].
6170
====
6271

6372

64-
65-
== 4.6 Approval for your end customer
73+
== Approval for your end customer
6674
When you decide that your application is successfully up and running and tested with the production environment, you can take all the steps relevant to publish your software to your customers like
6775

6876
* deploying it on the server
@@ -73,4 +81,4 @@ When you decide that your application is successfully up and running and tested
7381
There are no additional steps required in the agrirouter UI or the agrirouter interface
7482

7583
== How to proceed
76-
Once you published your software and customers start using it, you should xref:../maintenance.adoc[maintain your solution].
84+
Once you published your software and customers start using it, you should xref:../maintenance.adoc[maintain your solution].

0 commit comments

Comments
 (0)