Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation needed #58

Open
EricGend opened this issue Dec 1, 2021 · 1 comment
Open

Documentation needed #58

EricGend opened this issue Dec 1, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@EricGend
Copy link

EricGend commented Dec 1, 2021

Hello,

I love your project, and see some huge potential in it. After all I'm stuck in a validation process of the software, is there any kind of documentation using the API to publish to a topic with some payload?

Also I'm unable to assigne a specific topic to a given user.

Kind regards Eric

@SebastianStehle
Copy link
Collaborator

Hi,
I totally agree: A lot of documentation is needed. Do you want to contibute? ;)

the full API spec is available as OpenAPI: https://notifo.easierlife.com/api/docs/index.html?url=/api/openapi.json

The endpoint you are looking for is this: https://notifo.easierlife.com/api/docs/index.html?url=/api/openapi.json#operation/Events_PostEvents

The endpoint accepts an array of events because it is optimized for bulk operations. I also recommend to use the creatorId because it is a user defined ID per event, which makes retry scenarios easier. So in case something goes wrong you can just resend the event using the same ID.

To assign a topic to a user you can use this endpoint: https://notifo.easierlife.com/api/docs/index.html?url=/api/openapi.json#operation/Users_PostSubscription

From the OpenAPI spec, the SDK is generated for .NET: https://www.nuget.org/packages/Notifo.SDK/1.0.0-beta9

We could also do it for other programming langauges.

@SebastianStehle SebastianStehle added the documentation Improvements or additions to documentation label Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants