נקודת קצה של API ליצירת קישורי הזמנה עברה ל-/invites.json

Is this related to the fact that the https://{defaultHost}/invites/link.json API stopped working today?

לייק 1

I’m not sure - it could be? I am not familiar with this endpoint.

Well, I have got a few hundreds emails from our automation now failing. We used the endpoint https://{defaultHost}/invites/link and we started getting 404. I check the documentation and the endpoint is now reported to be https://{defaultHost}/invites/link.json (with the extra .json), but also with that change I keep getting 404.
I am not sure how to fix that. We need to generate invite links to send them through our systems. It worked beautifully until today

Also, doing a PUT to that address return BAD REQUEST, but a PUT to an unexisting address returns NOT FOUND. I am not sure if this is an hint that the endpoint is there and it is just not working

Maybe I should specify that I have an instance of Discourse hosted by you at https://d.strumenta.community/

That API endpoint was moved to https://{defaultHost}/invites.json as we consolidated the email and link invites.

2 לייקים

Ok, then I think the documentation is not up-to-date

Does this endpoint generates an invite link, but does not send an email?

Because according to the documentation the difference betweek /invites.json and and /invites/link.json is the sending of the email

לייק 1

Also, a post to /invites.json returns BAD REQUEST for me → my bad, I should use " and not '

With the correction, I get an answered telling the user was emailed, and I would like to prevent that:

It would be useful to have a notification when API changes and get access to the current documentation, otherwise stuff breaks all of a sudden and one cannot fix it…

Adding this here, just for visibility:

$ curl 'http://localhost:3000/invites.json' -X 'POST' \
  -H "Api-Key: d5fc02c5f4efaafacc82e4ff3410ae283d1c5da68ac43430d5133aaf4785593f" \
  -H "Api-Username: dan" \
  -H "Content-Type: application/json" \
  -d "{\"max_redemptions_allowed\":5}"
{"id":18,"link":"http://localhost:3000/invites/6f524dba4ced35ecae709a8614db3b05","redemption_count":0,"max_redemptions_allowed":5,"custom_message":null,"updated_at":"2021-03-10T15:44:44.259Z","expires_at":"2021-04-09T15:44:44.258Z","expired":false,"topics":[],"groups":[]}%                             

I will be updating our API documentation. Thank you for bringing that to my attention and sorry for the inconvenience.

7 לייקים

It would be nice if create returned the existing invite link instead of throwing an error if it’s from the same user. The 422 error response is pretty generic, it took me ages to figure out why my tests were failing.

לייק 1

Added a PR for retrieving an existing invite by email address: https://github.com/discourse/discourse/pull/12575

לייק 1

I found an undocumented flag skip_email that prevents the email being sent so you can just grab the link. Pass it in the body with the email and you should be good!

    {
        "email": "someone@test.com",
        "skip_email": "true"
    }

I did some brief testing and it’s worth noting that if you use it to generate an email link, then you can’t go back and use it to send an email automatically - emailed always returns false once skip_email is used.

לייק 1

Is there any reason invites/retrieve.json isn’t in the documentation under Discourse API Docs ? Or am I missing something.

I want to invite email addresses which exist in an external database, only if a) they don’t already have an account, and b) if they haven’t already been invited (this process will run periodically and I don’t want to spam people who haven’t responded to their invitation fast enough). invites/retrieve.json seems to be the right way to figure out (b) per what it looks like is in the commit.

2 לייקים

It’s likely just an oversight that its missing from the api docs, I’ll work on getting it added.

2 לייקים

It’d be cool if those were generated by, or at least tested against, current discourse core.

It’d seem like there’d be a reasonably simple way (which probably means 2 days work and not the 1 hour that I’d like to believe!) to have specs run to test them. Oh, or maybe that’s what https://redocly.com/ is supposed to do?

What would really be nice for my use case is a way to retrieve all invites invited by all users. If “by all users” is the breaking point, it’d be fine for my use case to retrieve all invites (regardless of state).

With this method I’m forced to poll each possibility, which could be 1000 email addresses when likely there are only a few in the table.

How to get a password from database? - #3 by pfaffman indicates the database isn’t exposed by default, so using code to access the db from an external process isn’t doable directly, at least not with my current implementation – and maybe it wouldn’t be a good idea to expose the db port in any case.

I’m trying to automate invitations and group membership for email addresses in an external database.

And twice it referred to the data explorer plugin, which is also the answer here, but maybe you need to know that you can Run Data Explorer queries with the Discourse API

ah yes, that was the key point I was missing – thanks for the pointer

לייק 1