Coverage for src/backend/InvenTree/plugin/samples/integration/api_caller.py: 0%

1"""Sample plugin for calling an external API.""" 

2 

3from plugin import InvenTreePlugin 

4from plugin.mixins import APICallMixin, SettingsMixin 

5 

6 

7class SampleApiCallerPlugin(APICallMixin, SettingsMixin, InvenTreePlugin): 

8 """A small api call sample.""" 

9 

10 NAME = 'Sample API Caller' 

11 

12 SETTINGS = { 

13 'API_TOKEN': { 

14 'name': 'API Token', 

15 'protected': True, 

16 'default': 'reqres-free-v1', 

17 }, 

18 'API_URL': { 

19 'name': 'External URL', 

20 'description': 'Where is your API located?', 

21 'default': 'api.example.com', 

22 }, 

23 } 

24 API_URL_SETTING = 'API_URL' 

25 API_TOKEN_SETTING = 'API_TOKEN' 

26 API_TOKEN = 'x-api-key' 

27 

28 def get_external_url(self): 

29 """Returns data from the sample endpoint.""" 

30 return self.api_call('api/users/2')