Skip to main content

Wolfia API (Beta)

Wolfia provides a RESTful API to integrate magic links into your custom workflows. Using the API key generated, you can create, update and read magic links.

info

This doc assumes you have already created API keys. If not, learn about generating API keys here

Here are the endpoints that you can use to interact with Wolfia API.

POST /magic-links

curl --silent --show-error --include --request POST \
--url https://api.wolfia.com/magic-links \
--header 'X-Api-Key-Id: <YOUR-API-KEY-ID>' \
--header 'X-Api-Key-Secret: <YOUR-API-KEY-SECRET>' \
--form 'linktitle=<YOUR-LINK-TITLE>' \
--form 'linkdescription=<YOUR-LINK-DESCRIPTION>' \
--form 'file=@<PATH-TO-YOUR-APK>'

Response

{
"link": "https://wolfia.com/magic-link/92bad635-fcb3-417d-b743-45c73054fddc",
"linkCreatedAt": "2022-08-18T20:15:00Z",
"linkCreatorUserId" : "D051DF17-F828-4F75-BE63-9F19C5B78680",
"linkCreatorDisplayName": "Jane Doe",
"linkTitle": "eng-1-add-dashboard - 11b7av1",
"linkDescription": "You can use the fake account: username: fake-jane, password: fake-jane to login to try out the app.",
"linkViewCount": 0,
"appInfo": {
"packageName": "com.wolfia",
"versionCode": 42,
"versionName": "2022.01.01.1",
"sdkVersion": 26,
"targetSdkVersion": 30,
"applicationLabel": "Wolfia"
}
}
curl --silent --show-error --include --request PATCH \
--url https://api.wolfia.com/magic-links \
--header 'X-Api-Key-Id: <YOUR-API-KEY-ID>' \
--header 'X-Api-Key-Secret: <YOUR-API-KEY-SECRET>' \
--header 'Content-Type: application/json' \
--data '{ magicLinkId: <YOUR-LINK-ID>, magicLinkTitle: <YOUR-LINK-TITLE>, magicLinkDescription:<YOUR-LINK-DESCRIPTION> }'

Response

{
"link": "https://wolfia.com/magic-link/92bad635-fcb3-417d-b743-45c73054fddc",
"linkCreatedAt": "2022-08-19T22:45:33Z",
"linkCreatorUserId" : "D051DF17-F828-4F75-BE63-9F19C5B78680",
"linkCreatorDisplayName": "Jane Doe",
"linkTitle": "eng-1-add-dashboard - 11b7av1",
"linkDescription": "You can use the fake account: username: fake-jane, password: updated-password to login to try out the app.",
"linkViewCount": 1,
"appInfo": {
"packageName": "com.wolfia",
"versionCode": 42,
"versionName": "2022.01.01.1",
"sdkVersion": 26,
"targetSdkVersion": 30,
"applicationLabel": "Wolfia"
}
}
curl --silent --show-error --include --request GET \
--url https://api.wolfia.com/magic-links \
--header 'X-Api-Key-Id: <YOUR-API-KEY-ID>' \
--header 'X-Api-Key-Secret: <YOUR-API-KEY-SECRET>'

Response

{
"magicLinks": [
{
"link": "https://wolfia.com/magic-link/92bad635-fcb3-417d-b743-45c72a54fddc",
"linkCreatedAt": "2022-08-19T22:50:30Z",
"linkCreatorUserId" : "D051DF17-F828-4F75-BE63-9F19C5B78680",
"linkCreatorDisplayName": "Jane Doe",
"linkTitle": "eng-1-add-dashboard - 11b7av1",
"linkDescription": "You can use the fake account: username: fake-jane, password: fake-jane to login to try out the app.",
"linkViewCount": 1,
"appInfo": {
"packageName": "com.wolfia",
"versionCode": 42,
"versionName": "2022.01.01.1",
"sdkVersion": 26,
"targetSdkVersion": 30,
"applicationLabel": "Wolfia"
}
},
{
"link": "https://wolfia.com/magic-link/1a8cc18b-b6bc-46f4-8ba1-900c80790c07",
"linkCreatedAt": "2022-08-20T22:00:30Z",
"linkCreatorUserId" : "6C1151F1-504A-404A-9ABF-17E93DF704C0",
"linkCreatorDisplayName": "John Doe",
"linkTitle": "eng-1-add-cool-feature-on-dashboard - 93f7a41",
"linkDescription": "Try out the cool new feature on the dashboard! 🥳",
"linkViewCount": 1,
"appInfo": {
"packageName": "com.wolfia",
"versionCode": 42,
"versionName": "2022.01.01.1",
"sdkVersion": 26,
"targetSdkVersion": 30,
"applicationLabel": "Wolfia"
}
}
]
}