Skip to content

Commit

Permalink
Various updated
Browse files Browse the repository at this point in the history
  • Loading branch information
codedeviate committed Aug 20, 2024
1 parent 20f020b commit 38414d9
Show file tree
Hide file tree
Showing 14 changed files with 561 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Writerside/topics/Auth-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

> The latest version of the Auth API is %AUTH_API_VERSION%
The AuthAPI is used to authenticate users for the [Portal API](Portal-API.md).
The AuthAPI is used to authenticate users for the [Portal API](Portal-API.md) and [MyQvickly API](MyQvickly-API.md).
6 changes: 6 additions & 0 deletions Writerside/topics/Create-a-paylink.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ Now we have reached the end of the first part where we let the customer scan the
}
}
</code-block>

[Here](Create-paylink-with-all-information.md) is an example of how to create a paylink with customer information.

</tab>
<tab title="Without customer information">
<code-block lang="json">
Expand Down Expand Up @@ -169,6 +172,9 @@ Now we have reached the end of the first part where we let the customer scan the
},
}
</code-block>

[Here](Create-paylink-without-personal-information.md) is an example of how to create a paylink with customer information.

</tab>
</tabs>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Create paylink with all information
# Create paylink without personal information

<include from="Snippets-PaylinkAPI.md" element-id="snippet-header" />

Expand Down
4 changes: 4 additions & 0 deletions Writerside/topics/Paylink-API-Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<include from="Snippets-PaylinkAPI.md" element-id="snippet-header" />

## 2024-08-19

Polished the text and corrected a few things.

## 2024-07-06

Added examples for Paylink API
Expand Down
3 changes: 3 additions & 0 deletions Writerside/topics/Paylink-Flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ participant "Customer" as C
M->Q: Add payment with method 256
Q->C: Paylink URL via email or QR code
C->Q: Pay
Q->C: Redirect customer to accept link
Q->M: Receive payment
@enduml
Expand All @@ -37,6 +38,7 @@ M->Q: Add payment with method 256
Q->M: Paylink URL
M->C: Display Paylink URL
C->Q: Pay
M->C: Redirect customer to accept link
Q->M: Receive payment
@enduml
Expand All @@ -58,6 +60,7 @@ Q->M: Paylink URL
M->Q: Update payment with the method to use
M->C: Display Paylink URL
C->Q: Pay
M->C: Redirect customer to accept link
Q->M: Receive payment
@enduml
Expand Down
4 changes: 4 additions & 0 deletions Writerside/topics/Portal-API-Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<include from="Snippets-PortalAPI.md" element-id="snippet-header" />

## 2024-08-19

Added hide2048 and show2048 filters

## 2024-07-06

Added documentation about filters
Expand Down
2 changes: 2 additions & 0 deletions Writerside/topics/address.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

<include from="Snippets-AuthAPI.md" element-id="snippet-header" />

For an example see [here](Auth-Example-address.md)

Start typing here...
455 changes: 454 additions & 1 deletion Writerside/topics/get.md

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions Writerside/topics/isPaid.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Method

## Request

| Property | Type | Description |
|----------|--------|-------------|
| Property | Type | Description |
|----------|--------|-------------------------|
| hash | string | The hash for the order. |

## Repsonse

Expand Down
4 changes: 4 additions & 0 deletions Writerside/topics/login.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Login

<include from="Snippets-AuthAPI.md" element-id="snippet-header" />

For an example see [here](Auth-Example-Login.md)

Start typing here...
27 changes: 26 additions & 1 deletion Writerside/topics/me.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@

<include from="Snippets-AuthAPI.md" element-id="snippet-header" />

Start typing here...
Find the information about the current logged in person from the token.

For an example see [here](Auth-Example-me.md)

## Response

<code-block lang="json">
{
"Merchant": {
"id": "%MERCHANT_ID%",
"name": "%MERCHANT_COMPANY%",
"secret": "%MERCHANT_KEY%",
"distributor": "0",
"mm3servicesid": "%SERVICE_ID%"
},
"User": {
"mm3useraccountsid": "%ACCOUNT_ID%",
"name": "%EXAMPLE_NAME%",
"username": "%EXAMPLE_USERNAME%",
"phonenumber": "%EXAMPLE_PHONE%",
"email": "%EXAMPLE_EMAIL%",
"personalnumber": "%EXAMPLE_PNO%",
},
"iat": 36244800
}
</code-block>
34 changes: 33 additions & 1 deletion Writerside/topics/updatePaymentMethod.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,36 @@
> This is an internal function used by the checkout
{style="warning"}

Start typing here...
{type="narrow"}
Endpoint
: /public/ajax.php?updatePaymentmethod

Method
: POST

## Request

| Property | Type | Description |
|----------|--------|-------------------------------------------|
| hash | string | The hash for the order. |
| method | string | The payment method used for the purchase. |

## Repsonse

| Property | Type | Description |
|----------|--------|---------------------------------------|
| number | string | The payments number |
| orderid | string | The orderid supplied in the payload |
| status | object | The current status of the checkout |
| url | string | The url for this checkout |
| pno | string | The personal number for the customer. |

```json
{
"number": "1234567",
"orderid": "OrderID-1234567",
"status": "Step2Loaded",
"url": "https:\/\/checkout.billmate.se\/%MERCHANT_ID%\/20240602123456789123456789",
"pno": "%EXAMPLE_PNO%"
}
```
14 changes: 14 additions & 0 deletions Writerside/v.list
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,20 @@

<var name="MERCHANT_ID" value="12345"/>
<var name="MERCHANT_KEY" value="123451234512"/>
<var name="MERCHANT_COMPANY" value="Qvickly Usability &amp; Testing AB"/>
<var name="MERCHANT_EMAIL" value="[email protected]"/>
<var name="SERVICE_ID" value="12345"/>
<var name="ACCOUNT_ID" value="12345"/>
<var name="EXAMPLE_NAME" value="Tess T Person"/>
<var name="EXAMPLE_FIRSTNAME" value="Tess T"/>
<var name="EXAMPLE_LASTNAME" value="Person"/>
<var name="EXAMPLE_USERNAME" value="tesstperson"/>
<var name="EXAMPLE_PHONE" value="46700000000"/>
<var name="EXAMPLE_ADDRESS" value="Testvägen 1"/>
<var name="EXAMPLE_CITY" value="Testinge"/>
<var name="EXAMPLE_ZIP" value="12345"/>
<var name="EXAMPLE_PNO" value="5501011018"/>
<var name="EXAMPLE_EMAIL" value="[email protected]"/>
<var name="DEVELOPER_MAIL_ADDRESS" value="[email protected]"/>

<var name="code-json" value="JSON"/>
Expand Down
6 changes: 6 additions & 0 deletions needsattention.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/bin/bash

echo "The following needs attention"

grep "Start typing here..." ./Writerside/topics/ -R | sort

0 comments on commit 38414d9

Please sign in to comment.