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

Register probe with API #1

Open
graphiclunarkid opened this issue May 29, 2014 · 3 comments
Open

Register probe with API #1

graphiclunarkid opened this issue May 29, 2014 · 3 comments

Comments

@graphiclunarkid
Copy link
Member

As a probe owner I want to register my probe with the blocked.org.uk API so that I can receive URLs and submit results.

API documentation is available however I don't know the sequence in which requests should be made. Hopefully @dantheta can confirm, but it looks like:

  1. POST /register/user (not sure whether this is in use yet)
  2. POST /prepare/probe
  3. POST /register/probe
@dantheta
Copy link

Yep, that's right. I've nearly finished the script that fetches batches of URLs to test as well.

@dantheta
Copy link

Also, /register/user is in use.

@dantheta
Copy link

I've created a wrapper script that pulls URLs from the API and passes them to OoniProbe.

https://github.com/dantheta/OoniWrapper (temporary repository)

This script includes a minimal registration routine - It assumes that /register/user has already happened, and expects the user's email address and secret as parameters. After that, it takes care of /prepare/probe and /register/probe.

I've placed it in a temporary repository of its own, since I didn't know how you would want it integrated. Feel free to place it (or a derivative) in this repo if and when you're ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants