search

GRESB / api-docs

http://gresb.github.io/api-docs/
3 stars 0 forks source link

specify which url to use for making a GRESB prod account #87

Closed joeyhorst closed 2 years ago

joeyhorst commented 2 years ago

specify that users need to create an account on portal.gresb.com, but use api.gresb.com for their requests

naincygoyal commented 2 years ago

@joeyhorst Can we ask developer to give an error if anyone use portal.gresb.com ? and can provide message to use api.gresb.com

joeyhorst commented 2 years ago

We could - as I believe you can also use portal.gresb.com as the base URL at the moment.

For now we mainly need to say the a user account/reporting entity is created in portal.gresb.com, but the base url for making api requests is api.gresb.com.

This feeds into the work @bartj3 @igorpertsev @00dav00 are doing (cc @DWolfgramm).

00dav00 commented 2 years ago

@joeyhorst @naincygoyal checking the way infra is setup with @miguelaferreira on Friday, I realized that after splitting the app into web and api, if a user tries to make a request to portal.gresb.com with an api route, the system will answer with a 404 since that route won't exist in the web container anymore. Is this what you had in mind? Or were you planning a more custom message?

joeyhorst commented 2 years ago

@00dav00 what we have in mind is that we need to inform the api user on which URL to create an account (portal.gresb.com) and on which URL to make requests (api.gresb.com).

I don't think we need a custom message if it is clearly specified in the api-docs.

Soon we'll take the UI away from api.gresb.com and then following our current docs the api user won't know where to create an account and reporting entity.

joeyhorst commented 2 years ago

closing this as it is already in master but still needs to be published