Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ on:
push:
branches: [master]
paths:
- docs/postman.json
- docs/openapi.yaml
- docs/portman/**

jobs:
release:
Expand All @@ -15,17 +15,37 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Extract version from postman.json
- uses: actions/setup-node@v4
with:
node-version: 20

- name: Install Portman dependencies
run: npm ci
working-directory: docs/portman

- name: Generate Postman collection
run: npm run generate
working-directory: docs/portman

- name: Extract version from openapi.yaml
id: version
run: |
VERSION=$(grep -oP 'Version:\s*\K[0-9]+\.[0-9]+\.[0-9]+' docs/postman.json | head -1)
VERSION=$(grep -oP 'version:\s*\K[0-9]+\.[0-9]+\.[0-9]+' docs/openapi.yaml | head -1)
echo "version=$VERSION" >> "$GITHUB_OUTPUT"

- name: Create GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: v${{ steps.version.outputs.version }}
name: v${{ steps.version.outputs.version }}
body: |
## Twikey API Kit

Download the assets below to get started:
- **postman.json** — Import into [Postman](https://www.postman.com/) to explore and test the API
- **openapi.yaml** — OpenAPI 3.0 specification for code generation and documentation

Both files are also available in the [`docs/`](https://github.com/twikey/development-kit/tree/master/docs) folder of the repository.
files: |
docs/postman.json
docs/openapi.yaml
Expand Down
14 changes: 7 additions & 7 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
[submodule "twikey-api-php"]
path = twikey-api-php
url = git@github.com:twikey/twikey-api-php.git
url = https://github.com/twikey/twikey-api-php.git
[submodule "twikey-api-go"]
path = twikey-api-go
url = git@github.com:twikey/twikey-api-go.git
url = https://github.com/twikey/twikey-api-go.git
[submodule "twikey-api-java"]
path = twikey-api-java
url = git@github.com:twikey/twikey-api-java.git
url = https://github.com/twikey/twikey-api-java.git
[submodule "twikey-api-python"]
path = twikey-api-python
url = git@github.com:twikey/twikey-api-python.git
url = https://github.com/twikey/twikey-api-python.git
[submodule "twikey-api-dotnet"]
path = twikey-api-dotnet
url = git@github.com:twikey/twikey-api-dotnet.git
url = https://github.com/twikey/twikey-api-dotnet.git
[submodule "twikey-api-node"]
path = twikey-api-node
url = git@github.com:twikey/twikey-api-node.git
url = https://github.com/twikey/twikey-api-node.git
[submodule "twikey-api-ruby"]
path = twikey-api-ruby
url = git@github.com:twikey/twikey-api-ruby.git
url = https://github.com/twikey/twikey-api-ruby.git
9 changes: 0 additions & 9 deletions .idea/code-snippets.iml

This file was deleted.

10 changes: 0 additions & 10 deletions .idea/vcs.xml

This file was deleted.

8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ You can find code samples for eg.
* Verifying the signature of the exit url
* Calculating the OTP when using enhanced security

## Guides

Guides for using the Twikey API and other developer recourses can be found at [Twikey developers](https://www.twikey.com/developers)

## Testing the API

[Postman](https://www.postman.com/) is an excellent API Testing solution, the postman file can be found in the [root of this repo](https://github.com/twikey/snippets/blob/master/postman.json)
or download an **already customised** one from your own environment [in the API section](https://www.twikey.com/r/admin#/c/settings/api).
Both an [OpenAPI](https://swagger.io/specification/) spec and a [Postman](https://www.postman.com/) collection are available in the [docs](docs/) folder and in the [latest release](https://github.com/twikey/development-kit/releases/latest). You can use either to explore and test all endpoints.

With this file you can test all endpoints.
Loading